org.jibx.custom.classes

Class SharedValueBase

java.lang.Object

org.jibx.custom.classes.CustomBase

org.jibx.custom.classes.SharedValueBase

Direct Known Subclasses:

ValueCustom, ValueCustom

public class SharedValueBase
extends CustomBase

Base class for all value customization information. This includes inherited values shared with customization extensions (in particular, the WSDL extensions). TODO: should this include more of the WSDL ValueCustom extensions? Look into how type mappings are handled in the BindGen code (uses bound type in WSDL)

Author:

Dennis M. Sosnoski

Field Summary

Fields

Modifier and Type	Field and Description
static StringArray	s_allowedAttributes Enumeration of allowed attribute names

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SharedValueBase(SharedNestingBase parent) Constructor.
protected	SharedValueBase(SharedNestingBase parent, String name) Constructor with name known.

Method Summary

Methods

Modifier and Type	Method and Description
static String	convertMemberNameCase(String name) Convert case of member name derived from name used in code.
protected void	fillType(IClass info, Boolean req, Integer style) Complete customization information based on supplied type.
String	getActualType() Get 'actual-type' attribute value.
String	getBaseName() Get value name as used in code.
ClassCustom	getClassCustom() Convenience method to access the containing class customization element.
String	getCreateType() Get 'create-type' attribute value.
String	getFactoryMethod() Get 'factory' attribute value.
String	getItemName() Get item element name.
String	getItemType() Get item type.
String	getStatedType() Get stated type of value, as declared in code.
int	getStyle() Get style code to apply to value.
String	getWorkingType() Get working type of member.
String	getXmlName() Get XML element or attribute name from customization.
boolean	isCollection() Check if collection member.
boolean	isElementForced() Check if element required.
boolean	isRequired() Check if value is required.
protected void	setBaseName(String name) Set value name as used in code.
protected void	setElementForced() Set element required.
protected void	setItemName(String name) Set item name.
protected void	setItemType(String type) Set item type.
protected void	setStyle(Integer style) Set style code to apply to value.
void	setXmlName(String name) Set XML element or attribute name from customization.

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

Constructor Detail

SharedValueBase

protected SharedValueBase(SharedNestingBase parent)

Constructor.

Parameters:

parent -

SharedValueBase

protected SharedValueBase(SharedNestingBase parent,
               String name)

Constructor with name known.

Parameters:

parent -

name -

Method Detail

getClassCustom

public ClassCustom getClassCustom()

Convenience method to access the containing class customization element.

Returns:

class customization

getBaseName

public String getBaseName()

Get value name as used in code. This is the actual name with any prefix or suffix stripped and the initial letter converted to lowercase unless the second letter is uppercase.

Returns:

name

setBaseName

protected void setBaseName(String name)

Set value name as used in code. This is only for use by subclasses.

Parameters:

name -

See Also:

getBaseName()

getStatedType

public String getStatedType()

Get stated type of value, as declared in code.

Returns:

stated type

getWorkingType

public String getWorkingType()

Get working type of member. This is the actual type from customization, if supplied, or stated type

Returns:

working type

convertMemberNameCase

public static String convertMemberNameCase(String name)

Convert case of member name derived from name used in code. If the supplied name starts with an uppercase letter followed by a lowercase letter, the initial letter is converted to lowercase in order to obtain a standard form of the name.

Parameters:

name -

Returns:

converted name

getStyle

public int getStyle()

Get style code to apply to value.

Returns:

value from NestingBase.s_valueStyleEnum enumeration

setStyle

protected void setStyle(Integer style)

Set style code to apply to value. This method is only intended for use by subclasses.

Parameters:

style -

getXmlName

public String getXmlName()

Get XML element or attribute name from customization.

Returns:

name (null if none)

setXmlName

public void setXmlName(String name)

Set XML element or attribute name from customization. This method is only intended for use by subclasses.

Parameters:

name -

getActualType

public String getActualType()

Get 'actual-type' attribute value.

Returns:

member actual type (null if none)

getCreateType

public String getCreateType()

Get 'create-type' attribute value.

Returns:

type used for creating new instance (null if none)

getFactoryMethod

public String getFactoryMethod()

Get 'factory' attribute value.

Returns:

method used for creating new instance (null if none)

isRequired

public boolean isRequired()

Check if value is required.

Returns:

true if required, false if not

isElementForced

public boolean isElementForced()

Check if element required. This is really only relevant when the value represents a collection of child elements, since it means a wrapper element is needed.

Returns:

true if element required, false if not

setElementForced

protected void setElementForced()

Set element required. This method is only intended for use by subclasses.

isCollection

public boolean isCollection()

Check if collection member.

Returns:

true if collection, false if not

getItemType

public String getItemType()

Get item type.

Returns:

item type

setItemType

protected void setItemType(String type)

Set item type. This method is intended only for use by subclasses.

Parameters:

type -

getItemName

public String getItemName()

Get item element name.

Returns:

item name

setItemName

protected void setItemName(String name)

Set item name. This method is intended only for use by subclasses.

Parameters:

name -

fillType

protected void fillType(IClass info,
            Boolean req,
            Integer style)

Complete customization information based on supplied type. If the type information has not previously been set, this will set it. It will also derive the appropriate XML name, if not previously set. This method is only intended for use by subclasses.

Parameters:

info - value type information

req - required member flag (null if unspecified)

style - representation style (null if unspecified)