org.jibx.binding.model
Class ObjectAttributes

java.lang.Object
  extended by org.jibx.binding.model.AttributeBase
      extended by org.jibx.binding.model.ObjectAttributes

public class ObjectAttributes
extends AttributeBase

Model component for object attribute group in binding definition.

Author:
Dennis M. Sosnoski

Field Summary
private static java.lang.String[] FACTORY_HOOK_SIGNATURES
           
private  IClass m_createClass
          Class to use for new instance creation.
private  java.lang.String m_createType
          Instance type for creation (fully qualified, including package and class).
private  IClassItem m_factoryItem
          Factory method information.
private  java.lang.String m_factoryName
          Factory method name (fully qualified, including package and class).
private  boolean m_isNillable
          Nillable object flag.
private  IClass m_marshallerClass
          Object marshaller class.
private  java.lang.String m_marshallerName
          Object marshaller class name.
private  IClassItem m_postSetItem
          Post-set method information.
private  java.lang.String m_postSetName
          Post-set method name.
private  IClassItem m_preGetItem
          Pre-get method information.
private  java.lang.String m_preGetName
          Pre-get method name.
private  IClassItem m_preSetItem
          Pre-set method information.
private  java.lang.String m_preSetName
          Pre-set method name.
private  IClass m_unmarshallerClass
          Object unmarshaller class.
private  java.lang.String m_unmarshallerName
          Object unmarshaller class name.
private static java.lang.String[] MARSHAL_HOOK_SIGNATURES
           
private static java.lang.String MARSHALLER_INTERFACE
           
private static java.lang.String MARSHALLER_INTERFACETYPE
           
static StringArray s_allowedAttributes
          Enumeration of allowed attribute names
private static java.lang.String[] UNMARSHAL_HOOK_SIGNATURES
           
private static java.lang.String UNMARSHALLER_INTERFACE
           
private static java.lang.String UNMARSHALLER_INTERFACETYPE
           
 
Constructor Summary
ObjectAttributes()
          Constructor.
 
Method Summary
 IClass getCreateClass()
          Get new instance creation class information.
 java.lang.String getCreateType()
          Get type to be used for creating new instance.
 IClassItem getFactory()
          Get factory method information.
 java.lang.String getFactoryName()
          Get factory method name.
 IClass getMarshaller()
          Get marshaller class information.
 java.lang.String getMarshallerName()
          Get marshaller class name.
 IClassItem getPostset()
          Get post-set method information.
 java.lang.String getPostsetName()
          Get post-set method name.
 IClassItem getPreget()
          Get pre-get method information.
 java.lang.String getPregetName()
          Get pre-get method name.
 IClassItem getPreset()
          Get pre-set method information.
 java.lang.String getPresetName()
          Get pre-set method name.
 IClass getUnmarshaller()
          Get unmarshaller class information.
 java.lang.String getUnmarshallerName()
          Get unmarshaller class name.
 boolean isNillable()
          Check if nillable object.
 void prevalidate(ValidationContext vctx)
          Prevalidate attribute information.
 void setCreateType(java.lang.String name)
          Set new instance type class name.
 void setFactoryName(java.lang.String name)
          Set factory method name.
 void setMarshallerName(java.lang.String name)
          Set marshaller class name.
 void setNillable(boolean nillable)
          Set nillable flag.
 void setPostsetName(java.lang.String name)
          Set post-set method name.
 void setPreget(java.lang.String name)
          Set pre-get method name.
 void setPresetName(java.lang.String name)
          Set pre-set method name.
 void setUnmarshallerName(java.lang.String name)
          Set unmarshaller class name.
 
Methods inherited from class org.jibx.binding.model.AttributeBase
validate
 
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


MARSHAL_HOOK_SIGNATURES

private static final java.lang.String[] MARSHAL_HOOK_SIGNATURES

FACTORY_HOOK_SIGNATURES

private static final java.lang.String[] FACTORY_HOOK_SIGNATURES

UNMARSHAL_HOOK_SIGNATURES

private static final java.lang.String[] UNMARSHAL_HOOK_SIGNATURES

UNMARSHALLER_INTERFACE

private static final java.lang.String UNMARSHALLER_INTERFACE
See Also:
Constant Field Values

MARSHALLER_INTERFACE

private static final java.lang.String MARSHALLER_INTERFACE
See Also:
Constant Field Values

UNMARSHALLER_INTERFACETYPE

private static final java.lang.String UNMARSHALLER_INTERFACETYPE
See Also:
Constant Field Values

MARSHALLER_INTERFACETYPE

private static final java.lang.String MARSHALLER_INTERFACETYPE
See Also:
Constant Field Values

m_factoryName

private java.lang.String m_factoryName
Factory method name (fully qualified, including package and class).


m_preSetName

private java.lang.String m_preSetName
Pre-set method name.


m_postSetName

private java.lang.String m_postSetName
Post-set method name.


m_preGetName

private java.lang.String m_preGetName
Pre-get method name.


m_marshallerName

private java.lang.String m_marshallerName
Object marshaller class name.


m_unmarshallerName

private java.lang.String m_unmarshallerName
Object unmarshaller class name.


m_isNillable

private boolean m_isNillable
Nillable object flag.


m_createType

private java.lang.String m_createType
Instance type for creation (fully qualified, including package and class).


m_factoryItem

private IClassItem m_factoryItem
Factory method information.


m_preSetItem

private IClassItem m_preSetItem
Pre-set method information.


m_postSetItem

private IClassItem m_postSetItem
Post-set method information.


m_preGetItem

private IClassItem m_preGetItem
Pre-get method information.


m_marshallerClass

private IClass m_marshallerClass
Object marshaller class.


m_unmarshallerClass

private IClass m_unmarshallerClass
Object unmarshaller class.


m_createClass

private IClass m_createClass
Class to use for new instance creation.

Constructor Detail

ObjectAttributes

public ObjectAttributes()
Constructor.

Method Detail

getFactoryName

public java.lang.String getFactoryName()
Get factory method name.

Returns:
fully-qualified factory class and method name (or null if none)

getFactory

public IClassItem getFactory()
Get factory method information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
factory method information (or null if none)

setFactoryName

public void setFactoryName(java.lang.String name)
Set factory method name.

Parameters:
name - fully qualified class and method name for object factory

getPresetName

public java.lang.String getPresetName()
Get pre-set method name.

Returns:
pre-set method name (or null if none)

getPreset

public IClassItem getPreset()
Get pre-set method information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
pre-set method information (or null if none)

setPresetName

public void setPresetName(java.lang.String name)
Set pre-set method name.

Parameters:
name - member method name to be called before unmarshalling

getPostsetName

public java.lang.String getPostsetName()
Get post-set method name.

Returns:
post-set method name (or null if none)

getPostset

public IClassItem getPostset()
Get post-set method information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
post-set method information (or null if none)

setPostsetName

public void setPostsetName(java.lang.String name)
Set post-set method name.

Parameters:
name - member method name to be called after unmarshalling

getPregetName

public java.lang.String getPregetName()
Get pre-get method name.

Returns:
pre-get method name (or null if none)

getPreget

public IClassItem getPreget()
Get pre-get method information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
pre-get method information (or null if none)

setPreget

public void setPreget(java.lang.String name)
Set pre-get method name.

Parameters:
name - member method name to be called before marshalling

getMarshallerName

public java.lang.String getMarshallerName()
Get marshaller class name.

Returns:
marshaller class name (or null if none)

getMarshaller

public IClass getMarshaller()
Get marshaller class information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
class information for marshaller (or null if none)

setMarshallerName

public void setMarshallerName(java.lang.String name)
Set marshaller class name.

Parameters:
name - class name to be used for marshalling

getUnmarshallerName

public java.lang.String getUnmarshallerName()
Get unmarshaller class name.

Returns:
unmarshaller class name (or null if none)

getUnmarshaller

public IClass getUnmarshaller()
Get unmarshaller class information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
class information for unmarshaller (or null if none)

setUnmarshallerName

public void setUnmarshallerName(java.lang.String name)
Set unmarshaller class name.

Parameters:
name - class name to be used for unmarshalling

isNillable

public boolean isNillable()
Check if nillable object.

Returns:
nillable flag

setNillable

public void setNillable(boolean nillable)
Set nillable flag.

Parameters:
nillable - flag

getCreateType

public java.lang.String getCreateType()
Get type to be used for creating new instance.

Returns:
class name for type to be created (or null if none)

getCreateClass

public IClass getCreateClass()
Get new instance creation class information. This method is only usable after a call to prevalidate(ValidationContext).

Returns:
class information for type to be created (or null if none)

setCreateType

public void setCreateType(java.lang.String name)
Set new instance type class name.

Parameters:
name - class name to be used for creating new instance

prevalidate

public void prevalidate(ValidationContext vctx)
Description copied from class: AttributeBase
Prevalidate attribute information. The prevalidation step is used to check attribute values in isolation, such as the settings for enumerated values and class file information. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.

Overrides:
prevalidate in class AttributeBase
Parameters:
vctx - validation context


Project Web Site