org.jibx.custom.classes

Class ClassCustom

java.lang.Object

org.jibx.custom.classes.CustomBase

org.jibx.custom.classes.SharedNestingBase

org.jibx.custom.classes.NestingBase

org.jibx.custom.classes.ClassCustom

All Implemented Interfaces:

IApply

public class ClassCustom
extends NestingBase
implements IApply

Class customization information. This supports direct class customizations (such as the corresponding element name, when building a concrete mapping) and also acts as a container for individual fields and/or properties.

Author:

Dennis M. Sosnoski

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Element name in XML customization file.
static int	FORM_ABSTRACT_MAPPING
static int	FORM_CONCRETE_MAPPING
static int	FORM_DEFAULT
static int	FORM_STRING
static StringArray	s_allowedAttributes Enumeration of allowed attribute names
static EnumSet	s_representationEnum

Fields inherited from class org.jibx.custom.classes.NestingBase

ATTRIBUTE_STYLE_INTEGER, ATTRIBUTE_VALUE_STYLE, ELEMENT_STYLE_INTEGER, ELEMENT_VALUE_STYLE, s_valueStyleEnum

Fields inherited from class org.jibx.custom.classes.CustomBase

CAMEL_CASE_NAMES, DERIVE_BY_PACKAGE, DERIVE_FIXED, DERIVE_NONE, DOTTED_NAMES, HYPHENATED_NAMES, REQUIRE_ALL, REQUIRE_NONE, REQUIRE_OBJECTS, REQUIRE_PRIMITIVES, s_namespaceStyleEnum, s_nameStyleEnum, s_requireEnum, UNDERSCORED_NAMES, UPPER_CAMEL_CASE_NAMES

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChild(CustomBase child) Add child.
void	apply(IClassLocator icl) Apply customizations to class to fill out members.
List	getChildren() Get list of children.
IClass	getClassInformation() Get actual class information.
String	getCreateType() Get the type name to be used when creating an instance of this class.
String	getDeserializer() Get deserializer method.
String	getElementName() Get the element name to be used for this class in a concrete mapping.
QName	getElementQName() Get the qualified element name to be used for this class in a concrete mapping.
String	getEnumValueMethod() Get the method used to retrieve the text value for an enum class.
String[]	getExcludes() Get list of names to be excluded from class representation.
String	getFactoryMethod() Get the factory method to be used when creating an instance of this class.
int	getForm() Get the representation code.
String[]	getIncludes() Get list of names to be included in class representation.
ValueCustom	getMember(String name) Get customization information for a member by name.
Collection	getMembers() Get collection of members in class.
String	getName() Get fully-qualified class name.
String	getSerializer() Get serializer method.
String	getSimpleName() Get simple class name.
String	getTypeName() Get the type name to be used for this class in an abstract mapping.
QName	getTypeQName() Get the qualified type name to be used for this class in an abstract mapping.
boolean	isAbstractMappingForced() Check if abstract mapping required for class.
boolean	isConcreteClass() Check if this is a directly instantiable class (not an interface, and not abstract)
boolean	isConcreteMappingForced() Check if concrete mapping required for class.
boolean	isSimpleValue() Check if class represents a simple text value.
boolean	isUseSuper() Check for superclass to be included in binding.
void	setCreateType(String type) Set the type name to be used when creating an instance of this class.

Methods inherited from class org.jibx.custom.classes.NestingBase

getStripPrefixes, getStripSuffixes, getValueStyle, isForceMapping, isForceStructureNames, isMapAbstract, isPropertyAccess, isWrapCollections, setMapAbstract, setValueStyle

Methods inherited from class org.jibx.custom.classes.SharedNestingBase

convertName, getFormatterClass, getNamespace, getNamespaceStyle, getNameStyle, getSpecifiedNamespace, isObjectRequired, isPrimitiveRequired, isUseJavaDocs, setNamespace, setNamespaceStyle, setNameStyle

Methods inherited from class org.jibx.custom.classes.CustomBase

convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes

Enumeration of allowed attribute names

ELEMENT_NAME

public static final String ELEMENT_NAME

Element name in XML customization file.

See Also:

Constant Field Values

FORM_DEFAULT

public static final int FORM_DEFAULT

See Also:

Constant Field Values

FORM_CONCRETE_MAPPING

public static final int FORM_CONCRETE_MAPPING

See Also:

Constant Field Values

FORM_ABSTRACT_MAPPING

public static final int FORM_ABSTRACT_MAPPING

See Also:

Constant Field Values

FORM_STRING

public static final int FORM_STRING

See Also:

Constant Field Values

s_representationEnum

public static final EnumSet s_representationEnum

Method Detail

getName

public String getName()

Get fully-qualified class name.

Returns:

class name

getSimpleName

public String getSimpleName()

Get simple class name.

Returns:

class name

getElementName

public String getElementName()

Get the element name to be used for this class in a concrete mapping.

Returns:

element name

getElementQName

public QName getElementQName()

Get the qualified element name to be used for this class in a concrete mapping.

Returns:

element name

getTypeName

public String getTypeName()

Get the type name to be used for this class in an abstract mapping.

Returns:

type name

getCreateType

public String getCreateType()

Get the type name to be used when creating an instance of this class.

Returns:

type name

setCreateType

public void setCreateType(String type)

Set the type name to be used when creating an instance of this class.

Parameters:

type -

getSerializer

public String getSerializer()

Get serializer method.

Returns:

serializer

getDeserializer

public String getDeserializer()

Get deserializer method.

Returns:

deserializer

getEnumValueMethod

public String getEnumValueMethod()

Get the method used to retrieve the text value for an enum class.

Returns:

method name

getFactoryMethod

public String getFactoryMethod()

Get the factory method to be used when creating an instance of this class.

Returns:

method name

getTypeQName

public QName getTypeQName()

Get the qualified type name to be used for this class in an abstract mapping.

Returns:

type qname

getForm

public int getForm()

Get the representation code.

Returns:

value from s_representationEnum enumeration

getExcludes

public String[] getExcludes()

Get list of names to be excluded from class representation.

Returns:

excludes (null if none)

getIncludes

public String[] getIncludes()

Get list of names to be included in class representation.

Returns:

includes (null if none)

isUseSuper

public boolean isUseSuper()

Check for superclass to be included in binding.

Returns:

true if superclass included, false if not

isConcreteClass

public boolean isConcreteClass()

Check if this is a directly instantiable class (not an interface, and not abstract)

Returns:

true if instantiable, false if not

isSimpleValue

public boolean isSimpleValue()

Check if class represents a simple text value.

Returns:

text value flag

isAbstractMappingForced

public boolean isAbstractMappingForced()

Check if abstract mapping required for class.

Returns:

abstract mapping flag

isConcreteMappingForced

public boolean isConcreteMappingForced()

Check if concrete mapping required for class. If a 'form' setting is defined for the class it returns the flag based on that setting, and otherwise returns based on the nesting abstract mapping flag.

Returns:

abstract mapping flag

getChildren

public List getChildren()

Get list of children.

Returns:

list

addChild

protected void addChild(CustomBase child)

Add child.

Parameters:

child -

apply

public void apply(IClassLocator icl)

Apply customizations to class to fill out members. The name handling gets tricky, because of the variety of options provided. The user can specify value names to be included and/or excluded for the class, and also value names to be treated as optional or required. If an 'includes' list is given, only the values on that list are processed from the class, along with any values with their own child elements. If an 'excludes' list is given, only the names not on that list are processed. If neither an 'includes' nor an 'excludes' list is present, all values defined by the class will be processed. It is an error if the same name occurs on both an 'excludes' list and any other list, or if a name on the 'excludes' list has a child element present. It is also an error if the same name occurs on both the 'optionals' and 'requireds' list. Each list name can also be flagged with a leading indicator character to say whether the value should be represented as an attribute ('@') or element ('<'). The order of child elements is also partially determined by the lists, with the 'includes' list processed first, then the 'requireds' list, then the 'optionals' list, then the child elements, then any values not yet processed.

Specified by:

apply in interface IApply

Parameters:

icl - class locator

getMember

public ValueCustom getMember(String name)

Get customization information for a member by name. This method may only be called after apply(IClassLocator).

Parameters:

name -

Returns:

customization, or null if none

getClassInformation

public IClass getClassInformation()

Get actual class information. This method may only be called after apply(IClassLocator).

Returns:

class information

getMembers

public Collection getMembers()

Get collection of members in class.

Returns:

members