BaseFactory (Castor JavaDoc)

java.lang.Object
- org.exolab.castor.builder.factory.BaseFactory

Direct Known Subclasses:

EnumerationFactory, MemberFactory, SourceFactory
```
public class BaseFactory
extends java.lang.Object
```
This class defines a base type for the source generator code factory classes.

Version:

$Revision: 6287 $ $Date: $

Author:

Werner Guttmann

Constructor Summary

Constructors
Constructor	Description
`BaseFactory(BuilderConfiguration config, FieldInfoFactory infoFactory, GroupNaming groupNaming, SourceGenerator sourceGenerator)`	Creates an instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected java.lang.String`	`createComment(Annotated annotated)`	Creates and returns a Javadoc comment from the given annotations.
`protected java.lang.String`	`extractCommentsFromAnnotations(Annotated annotated)`	Creates Comments from Schema annotations.
`protected BuilderConfiguration`	`getConfig()`	Get BuilderConfiguration instance, for callbacks to obtain certain configured properties.
`GroupNaming`	`getGroupNaming()`	Returns the group naming helper class for naming nested anonymous groups.
`protected FieldInfoFactory`	`getInfoFactory()`	Get type factory.
`JavaNaming`	`getJavaNaming()`	To get the `JavaNaming` to be used.
`protected SourceGenerator`	`getSourceGenerator()`	Returns the calling `SourceGenerator` instance.
`protected java.lang.String`	`normalize(java.lang.String value)`	Normalizes the given string for use in comments.
`void`	`setGroupNaming(GroupNaming groupNaming)`	Sets the group naming helper class for naming nested anonymous groups.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseFactory
```
public BaseFactory(BuilderConfiguration config,
                   FieldInfoFactory infoFactory,
                   GroupNaming groupNaming,
                   SourceGenerator sourceGenerator)
```
    Creates an instance of this class.
    
    Parameters:
    
    config - XML code generator configuration
    
    infoFactory - the FieldInfoFactory to use
    
    groupNaming - Group naming scheme to be used.
    
    sourceGenerator - The calling source generator.
- Method Detail
  - getConfig
```
protected final BuilderConfiguration getConfig()
```
    Get BuilderConfiguration instance, for callbacks to obtain certain configured properties.
    
    Returns:
    
    BuilderConfiguration instance.
  - getInfoFactory
```
protected final FieldInfoFactory getInfoFactory()
```
    Get type factory.
    
    Returns:
    
    Type factory.
  - normalize
```
protected final java.lang.String normalize(java.lang.String value)
```
    Normalizes the given string for use in comments.
    
    Parameters:
    
    value - the String to normalize
    
    Returns:
    
    the given string, normalized, for use in comments.
  - getGroupNaming
```
public final GroupNaming getGroupNaming()
```
    Returns the group naming helper class for naming nested anonymous groups.
    
    Returns:
    
    the group naming helper class for naming nested anonymous groups.
  - setGroupNaming
```
public final void setGroupNaming(GroupNaming groupNaming)
```
    Sets the group naming helper class for naming nested anonymous groups.
    
    Parameters:
    
    groupNaming - the group naming helper class for naming nested anonymous groups.
  - getSourceGenerator
```
protected SourceGenerator getSourceGenerator()
```
    Returns the calling SourceGenerator instance.
    
    Returns:
    
    the calling source generator
  - createComment
```
protected java.lang.String createComment(Annotated annotated)
```
    Creates and returns a Javadoc comment from the given annotations.
    
    Parameters:
    
    annotated - The Annotated instance holding annotations.
    
    Returns:
    
    The Javadoc comment created from the annotations.
  - extractCommentsFromAnnotations
```
protected java.lang.String extractCommentsFromAnnotations(Annotated annotated)
```
    Creates Comments from Schema annotations.
    
    Parameters:
    
    annotated - the Annotated structure to process
    
    Returns:
    
    the generated comment.
  - getJavaNaming
```
public final JavaNaming getJavaNaming()
```
    To get the JavaNaming to be used.
    
    Returns:
    
    JavaNaming instance to be used
    
    Since:
    
    1.1.3

Class BaseFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseFactory

Method Detail

getConfig

getInfoFactory

normalize

getGroupNaming

setGroupNaming

getSourceGenerator

createComment

extractCommentsFromAnnotations

getJavaNaming