|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibx.schema.codegen.custom.CustomBase
org.jibx.schema.codegen.custom.NestingCustomBase
org.jibx.schema.codegen.custom.SchemaRootBase
public abstract class SchemaRootBase
Base class for possible root customizations.
Nested Class Summary | |
---|---|
static class |
SchemaRootBase.ClassDecoratorUnmarshaller
Unmarshaller for class decorator extension elements. |
static class |
SchemaRootBase.ExtensionUnmarshaller
Unmarshaller for extension elements. |
static class |
SchemaRootBase.NameConverterUnmarshaller
Unmarshaller for name converter extension elements. |
Field Summary | |
---|---|
private static ClassDecorator[] |
EMPTY_DECORATORS_ARRAY
|
private static java.lang.String[] |
EMPTY_STRING_ARRAY
Empty array used as return value when nothing else specified. |
static int |
ENUM_JAVA5
|
static int |
ENUM_SIMPLE
|
private java.util.List |
m_classDecorators
Decorators to be used in code generation ( null if none set at level). |
private java.lang.Boolean |
m_deleteAnnotations
Delete annotations flag. |
private int |
m_enumCode
Code for enumeration representation ( -1 if not set at level). |
private java.lang.Boolean |
m_generateAll
Generate even unused global definitions. |
private java.lang.Boolean |
m_importDocs
Convert schema documentation to JavaDocs in generated code flag. |
private java.lang.Boolean |
m_inheritDecorators
Inherit code generation class decorators from parent flag. |
private java.lang.Integer |
m_lineWidth
Preferred maximum line width for generated code. |
private NameConverter |
m_nameConverter
Name converter instance ( null if none set at level). |
private java.lang.Boolean |
m_nullCollection
Force separate class for collection flag. |
private java.lang.String |
m_package
Fully-qualified package name. |
private java.lang.Boolean |
m_preferInline
Prefer inline definitions (separate classes for all if FALSE ). |
private int |
m_repeatCode
Code for repeated value representation ( -1 if not set at level). |
private java.lang.Boolean |
m_showSchema
Include schema fragments in generated class JavaDocs flag. |
private java.lang.Boolean |
m_structureOptional
Set references as optional structure where possible flag. |
private java.lang.Boolean |
m_useInner
Use inner classes for substructures (top-level classes for all if FALSE ). |
static int |
REPEAT_ARRAY
|
static int |
REPEAT_LIST
|
static int |
REPEAT_TYPED
|
static StringArray |
s_allowedAttributes
Enumeration of allowed attribute names |
private static NameConverter |
s_defaultNameConverter
Default converter used if none set. |
static EnumSet |
s_enumValues
|
static EnumSet |
s_repeatValues
|
Fields inherited from class org.jibx.schema.codegen.custom.NestingCustomBase |
---|
ANY_DISCARD, ANY_DOM, ANY_MAPPED, s_anyValues, s_selectionValues, SELECTION_CHECKEDBOTH, SELECTION_CHECKEDSET, SELECTION_OVERRIDEBOTH, SELECTION_OVERRIDESET, SELECTION_UNCHECKED |
Constructor Summary | |
---|---|
SchemaRootBase(SchemaRootBase parent)
Constructor. |
Method Summary | |
---|---|
private void |
addClassDecorator(ClassDecorator decor)
Add a class decorator to the current list. |
private static ClassDecorator |
classDecoratorFactory(IUnmarshallingContext ictx)
Create an instance of the appropriate class decorator class, to be used for unmarshalling. |
ClassDecorator[] |
getClassDecorators()
Get class decorators. |
java.lang.String |
getEnumText()
Get the enumeration representation text value set specifically for this element. |
int |
getEnumType()
Get the enumeration representation type code to be applied for this schema or set of schemas. |
int |
getLineWidth()
Get the preferred maximum line width used for generated classes. |
NameConverter |
getNameConverter()
Get name converter. |
java.lang.String |
getPackage()
Get fully-qualified package name. |
java.lang.String |
getRepeatText()
Get the repeated value representation text value set specifically for this element. |
int |
getRepeatType()
Get the repeated value representation type code to be applied for this schema or set of schemas. |
SchemaRootBase |
getRootParent()
Get parent customization (which will either be null , or another instance of this class). |
boolean |
isDeleteAnnotations()
Check whether annotations are to be deleted. |
boolean |
isGenerateAll()
Check whether unused definitions should be included in code generation. |
boolean |
isJavaDocDocumentation()
Check whether schema documentation is to be used for JavaDocs in the generated code. |
boolean |
isNullCollectionAllowed()
Check whether collection holder (array, list, etc.) can be null . |
boolean |
isPreferInline()
Check whether inlining of components is preferred. |
boolean |
isSchemaFragmentDocumentation()
Check whether schema fragments matching a generated class are to be included in the class JavaDocs. |
boolean |
isStructureOptional()
Check whether references to classes with no associated element and all components optional should be made optional in the generated binding. |
boolean |
isUseInner()
Check whether inner classes are preferred for components used only by one definition. |
private void |
setEnumText(java.lang.String text,
IUnmarshallingContext ictx)
Set the enumeration representation text value. |
void |
setEnumType(int code)
Set the enumeration representation type code. |
private void |
setNameConverter(NameConverter nconv,
IUnmarshallingContext ictx)
Set name converter to be used. |
private void |
setRepeatText(java.lang.String text,
IUnmarshallingContext ictx)
Set the repeated value representation text value. |
void |
setRepeatType(int code)
Set the repeated value representation type code. |
Methods inherited from class org.jibx.schema.codegen.custom.NestingCustomBase |
---|
getActiveFacetsMask, getAnyHandling, getAnyType, getChildren, getChoiceHandling, getChoiceType, getReplacement, getSubstitutions, getUnionHandling, getUnionType, isChoiceExposed, isUnionExposed, setAnyType, setChoiceType, setEnforcedFacets, setIgnoredFacets, setReplacement, setSubstitutions, setUnionType, validate |
Methods inherited from class org.jibx.schema.codegen.custom.CustomBase |
---|
getContainingObject, getParent, getSchemaRoot, setParent, validateAttributes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String[] EMPTY_STRING_ARRAY
private static final ClassDecorator[] EMPTY_DECORATORS_ARRAY
public static final StringArray s_allowedAttributes
private static final NameConverter s_defaultNameConverter
public static final int REPEAT_ARRAY
public static final int REPEAT_LIST
public static final int REPEAT_TYPED
public static final EnumSet s_repeatValues
public static final int ENUM_JAVA5
public static final int ENUM_SIMPLE
public static final EnumSet s_enumValues
private java.lang.String m_package
private java.lang.Boolean m_generateAll
private java.lang.Boolean m_preferInline
FALSE
).
private java.lang.Boolean m_useInner
FALSE
).
private java.lang.Boolean m_deleteAnnotations
private java.lang.Boolean m_importDocs
private java.lang.Boolean m_showSchema
private java.lang.Boolean m_nullCollection
private java.lang.Boolean m_structureOptional
private NameConverter m_nameConverter
null
if none set at level).
private java.lang.Boolean m_inheritDecorators
private java.util.List m_classDecorators
null
if none set at level).
private java.lang.Integer m_lineWidth
private int m_repeatCode
-1
if not set at level).
private int m_enumCode
-1
if not set at level).
Constructor Detail |
---|
public SchemaRootBase(SchemaRootBase parent)
parent
- Method Detail |
---|
public SchemaRootBase getRootParent()
null
, or another instance of this class).
null
if nonepublic boolean isGenerateAll()
true
if not
overridden at any level.
public boolean isPreferInline()
false
if not overridden at any
level.
public boolean isUseInner()
true
if not overridden at any level.
public boolean isDeleteAnnotations()
true
if not overridden at any level.
public boolean isJavaDocDocumentation()
true
if not overridden at any level.
public boolean isSchemaFragmentDocumentation()
true
if not overridden at any level.
public boolean isNullCollectionAllowed()
null
. This is only relevant to
collections using an optional wrapper element: If this flag is true
a null
collection
holder indicates the element is missing; otherwise a class is created to wrap the collection holder, and a
null
for that class indicates the element is missing. The default is true
if not
overridden at any level.
TODO: currently unsupported
public boolean isStructureOptional()
null
when unmarshalling if none of the components are present, and will be checked for
null
when marshalling. The default is true
if not overridden at any level.
public int getLineWidth()
public int getRepeatType()
REPEAT_TYPED
if not overridden at any level.
public void setRepeatType(int code)
code
- type code, -1
if to be unsetpublic java.lang.String getRepeatText()
null
if not set)private void setRepeatText(java.lang.String text, IUnmarshallingContext ictx)
text
- (null
if not set)ictx
- public int getEnumType()
ENUM_JAVA5
if not overridden at any level.
public void setEnumType(int code)
code
- type code, -1
if to be unsetpublic java.lang.String getEnumText()
null
if not set)private void setEnumText(java.lang.String text, IUnmarshallingContext ictx)
text
- (null
if not set)ictx
- public java.lang.String getPackage()
null
if none set)private void setNameConverter(NameConverter nconv, IUnmarshallingContext ictx)
nconv
- ictx
- public NameConverter getNameConverter()
null
if none defined)private void addClassDecorator(ClassDecorator decor)
decor
- public ClassDecorator[] getClassDecorators()
private static ClassDecorator classDecoratorFactory(IUnmarshallingContext ictx)
ictx
-
null
if error
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |