org.jibx.custom.classes

Class ValueCustom

java.lang.Object

org.jibx.custom.classes.CustomBase

org.jibx.custom.classes.SharedValueBase

org.jibx.custom.classes.ValueCustom

public class ValueCustom
extends SharedValueBase

Member field or property customization information.

Author:

Dennis M. Sosnoski

Property Summary

Properties

Type	Property and Description
boolean	is Check if member represents a property.

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	ValueCustom(SharedNestingBase parent) Constructor.
protected	ValueCustom(SharedNestingBase parent, String name) Constructor with name known.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFieldName() Get 'field' attribute value.
String	getGetName() Get 'get-method' attribute name.
String	getPropertyName() Get 'property-name' attribute value.
String	getSetName() Get 'set-method' attribute name.
boolean	isPrivate() Check if a private member.
boolean	isProperty() Check if member represents a property.
static String	memberNameFromField(String name, String[] prefs, String[] suffs) Get the member name for a field from the field name.
static String	memberNameFromGetMethod(String name) Get the member name for a property from the read method name.
static String	memberNameFromSetMethod(String name) Get the member name for a property from the write method name.
protected void	postSet() Post-set method that handles checking attribute combinations and sets the actual member name.
protected void	preSet(IUnmarshallingContext uctx) Make sure all attributes are defined.

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

convertMemberNameCase, fillType, getActualType, getBaseName, getClassCustom, getCreateType, getFactoryMethod, getItemName, getItemType, getStatedType, getStyle, getWorkingType, getXmlName, isCollection, isElementForced, isRequired, setBaseName, setElementForced, setItemName, setItemType, setStyle, setXmlName

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

Property Detail

is

Check if member represents a property.

Returns:

true

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes

Enumeration of allowed attribute names

Constructor Detail

ValueCustom

protected ValueCustom(SharedNestingBase parent)

Constructor.

Parameters:

parent -

ValueCustom

protected ValueCustom(SharedNestingBase parent,
           String name)

Constructor with name known.

Parameters:

parent -

name -

Method Detail

memberNameFromGetMethod

public static String memberNameFromGetMethod(String name)

Get the member name for a property from the read method name. This means stripping off the leading "get" or "is" prefix, then case-converting the result.

Parameters:

name -

Returns:

member name

See Also:

SharedValueBase.convertMemberNameCase(String), memberNameFromSetMethod(String), memberNameFromField(String, String[], String[])

memberNameFromSetMethod

public static String memberNameFromSetMethod(String name)

Get the member name for a property from the write method name. This means stripping off the leading "set" prefix, then case-converting the result.

Parameters:

name -

Returns:

member name

See Also:

SharedValueBase.convertMemberNameCase(String), memberNameFromGetMethod(String), memberNameFromField(String, String[], String[])

memberNameFromField

public static String memberNameFromField(String name,
                         String[] prefs,
                         String[] suffs)

Get the member name for a field from the field name. This means stripping off and leading field name prefix and/or trailing suffix, then case-converting the result.

Parameters:

name -

prefs - field prefixes to be stripped

suffs - field suffixes to be stripped

Returns:

member name

See Also:

SharedValueBase.convertMemberNameCase(String), memberNameFromGetMethod(String), memberNameFromSetMethod(String)

isProperty

public boolean isProperty()

Check if member represents a property.

Returns:

true

isPrivate

public boolean isPrivate()

Check if a private member.

Returns:

true if private, false if not

getFieldName

public String getFieldName()

Get 'field' attribute value.

Returns:

'field' value (null if none)

getGetName

public String getGetName()

Get 'get-method' attribute name.

Returns:

'get' attribute name (null if none)

getSetName

public String getSetName()

Get 'set-method' attribute name.

Returns:

'set-method' attribute name (null if none)

getPropertyName

public String getPropertyName()

Get 'property-name' attribute value.

Returns:

property name (null if none)

preSet

protected void preSet(IUnmarshallingContext uctx)

Make sure all attributes are defined.

Parameters:

uctx - unmarshalling context

postSet

protected void postSet()
                throws JiBXException

Post-set method that handles checking attribute combinations and sets the actual member name.

Throws:

JiBXException