org.jibx.binding.def
Interface ITypeBinding

All Known Subinterfaces:

IContextObj

All Known Implementing Classes:

ObjectBinding, PrecompiledBinding

public interface ITypeBinding

Interface for accessing methods used in a type binding. All the methods accessed by this interface are public, static, methods.

Author:

Dennis M. Sosnoski

Method Summary

java.lang.String	getAttributeMarshalMethod() Get the method which marshals attributes from an instance.
java.lang.String	getAttributePresentTestMethod() Get the method which checks attributes to determine if an instance is present.
java.lang.String	getAttributeUnmarshalMethod() Get the method which unmarshals attributes into an instance.
java.lang.String	getCompleteMethod() Get the method which handles unmarshalling completion.
java.lang.String	getContentMarshalMethod() Get the method which marshals child elements and character data content from an instance.
java.lang.String	getContentPresentTestMethod() Get the method which checks child elements to determine if an instance is present.
java.lang.String	getContentUnmarshalMethod() Get the method which unmarshals child elements and character data content into an instance.
java.lang.String	getCreateMethod() Get the method which creates an instance of the bound class if one does not already exist.
java.lang.String	getPrepareMethod() Get the method which handles preparation for marshalling an instance.

Method Detail

getCreateMethod

java.lang.String getCreateMethod()
                                 throws JiBXException

Get the method which creates an instance of the bound class if one does not already exist. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. If the passed reference is non-null that reference will simply be returned; otherwise, a new instance will be created and returned. This method also handles any appropriate pre-set processing for the instance.

Returns:

create method, or null if none

Throws:

JiBXException - on error in code generation

getCompleteMethod

java.lang.String getCompleteMethod()
                                   throws JiBXException

Get the method which handles unmarshalling completion. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.

Returns:

complete method, or null if none

Throws:

JiBXException - on error in code generation

getPrepareMethod

java.lang.String getPrepareMethod()
                                  throws JiBXException

Get the method which handles preparation for marshalling an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.

Returns:

prepare method, or null if none

Throws:

JiBXException - on error in code generation

getAttributePresentTestMethod

java.lang.String getAttributePresentTestMethod()
                                               throws JiBXException

Get the method which checks attributes to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returns true if an attribute of the mapping is found, false if not.

Returns:

test method, or null if none

Throws:

JiBXException - on error in code generation

getAttributeUnmarshalMethod

java.lang.String getAttributeUnmarshalMethod()
                                             throws JiBXException

Get the method which unmarshals attributes into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.

Returns:

attribute unmarshal method, or null if none

Throws:

JiBXException - on error in code generation

getAttributeMarshalMethod

java.lang.String getAttributeMarshalMethod()
                                           throws JiBXException

Get the method which marshals attributes from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.

Returns:

attribute marshal method, or null if none

Throws:

JiBXException - on error in code generation

getContentPresentTestMethod

java.lang.String getContentPresentTestMethod()
                                             throws JiBXException

Get the method which checks child elements to determine if an instance is present. This method takes the unmarshalling context as the only parameter. It returns true if an attribute of the mapping is found, false if not.

Returns:

content test method, or null if none

Throws:

JiBXException - on error in code generation

getContentUnmarshalMethod

java.lang.String getContentUnmarshalMethod()
                                           throws JiBXException

Get the method which unmarshals child elements and character data content into an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method. The return value is the unmarshalled instance, which may not be the same instance as was passed as a parameter.

Returns:

content unmarshal method, or null if none

Throws:

JiBXException - on error in code generation

getContentMarshalMethod

java.lang.String getContentMarshalMethod()
                                         throws JiBXException

Get the method which marshals child elements and character data content from an instance. This method takes a reference to the bound type as the first parameter and the unmarshalling context as the second parameter. There is no return value from the method.

Returns:

content marshal method, or null if none

Throws:

JiBXException - on error in code generation