org.jibx.binding.def

Class PropertyDefinition

java.lang.Object

org.jibx.binding.def.PropertyDefinition

public class PropertyDefinition
extends Object

Property definition from binding. This organizes shared information for bindings linked to fields or get/set methods of an object, and provides methods for related code generation.

Author:

Dennis M. Sosnoski

Constructor Summary

Constructors

Constructor and Description
PropertyDefinition(IContainer parent, IContextObj obj, String type, boolean isthis, boolean opt, String fname, String test, String flag, String get, String set) Constructor.
PropertyDefinition(IContextObj obj, boolean opt) Constructor for "this" object reference.
PropertyDefinition(PropertyDefinition original) Copy constructor.
PropertyDefinition(String type, IContextObj obj, boolean opt) Constructor for implicit object reference.

Method Summary

Modifier and Type	Method and Description
void	genFlag(MethodBuilder mb) Generate code to call flag method with value on stack.
void	genLoad(ContextMethodBuilder mb) Generate code to load property value to stack.
void	genStore(MethodBuilder mb) Generate code to store property value from stack.
BranchWrapper	genTest(ContextMethodBuilder mb) Generate code to test if property is present.
String	getGetValueType() Get value type as fully qualified name for loaded property value.
String	getName() Get property name.
String	getSetValueType() Get value type as fully qualified name for stored property value.
String	getTypeName() Get declared type fully qualified name.
boolean	hasFlag() Check if property has flag method.
boolean	hasTest() Check if property has presence test.
boolean	isFlagOnly() Check if property is flag only.
boolean	isImplicit() Check if property is implicit value from collection.
boolean	isLoadable() Check if the value can be loaded.
boolean	isOptional() Check if property is optional.
boolean	isTestOnly() Check if property is test only.
boolean	isThis() Check if property is "this" reference for object.
void	setOptional(boolean opt) Set flag for an optional property.
void	switchProperty() Switch property from "this" to "implicit".
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyDefinition

public PropertyDefinition(IContainer parent,
                          IContextObj obj,
                          String type,
                          boolean isthis,
                          boolean opt,
                          String fname,
                          String test,
                          String flag,
                          String get,
                          String set)
                   throws org.jibx.runtime.JiBXException

Constructor.

Parameters:

parent - containing binding definition structure

obj - containing object context

type - fully qualified name of type

isthis - "this" object reference flag

opt - optional property flag

fname - containing object field name for property (may be null)

test - containing object method to test for property present (may be null)

flag - containing object method to flag property present (may be null)

get - containing object method to get property value (may be null)

set - containing object method to set property value (may be null)

Throws:

org.jibx.runtime.JiBXException - if configuration error

PropertyDefinition

public PropertyDefinition(IContextObj obj,
                          boolean opt)

Constructor for "this" object reference.

Parameters:

obj - containing object context

opt - optional property flag

PropertyDefinition

public PropertyDefinition(String type,
                          IContextObj obj,
                          boolean opt)

Constructor for implicit object reference.

Parameters:

type - object type supplied

obj - containing object context

opt - optional property flag

PropertyDefinition

public PropertyDefinition(PropertyDefinition original)

Copy constructor.

Parameters:

original - Property Definition

Method Detail

isThis

public boolean isThis()

Check if property is "this" reference for object.

Returns:

true if reference to "this", false if not

isImplicit

public boolean isImplicit()

Check if property is implicit value from collection.

Returns:

true if implicit, false if not

switchProperty

public void switchProperty()

Switch property from "this" to "implicit".

isOptional

public boolean isOptional()

Check if property is optional.

Returns:

true if optional, false if required

setOptional

public void setOptional(boolean opt)

Set flag for an optional property.

Parameters:

opt - true if optional property, false if not

isLoadable

public boolean isLoadable()

Check if the value can be loaded.

Returns:

true if loadable, false if not

getName

public String getName()

Get property name. If a field is defined this is the same as the field; otherwise it is either the get method name (with leading "get" stripped, if present) or the set method (with leading "set" stripped, if present), whichever is found.

Returns:

name for this property

getTypeName

public String getTypeName()

Get declared type fully qualified name.

Returns:

fully qualified class name of declared type

getGetValueType

public String getGetValueType()

Get value type as fully qualified name for loaded property value.

Returns:

fully qualified class name of value type

getSetValueType

public String getSetValueType()

Get value type as fully qualified name for stored property value.

Returns:

fully qualified class name of value type

hasTest

public boolean hasTest()

Check if property has presence test. Code needs to be generated to check for the presence of the property if it is optional and either a test method is defined or the value is an object reference.

Returns:

true if presence test needed, false if not

isTestOnly

public boolean isTestOnly()

Check if property is test only.

Returns:

true if test-only property, false if not

hasFlag

public boolean hasFlag()

Check if property has flag method.

Returns:

true if flag method defined, false if not

isFlagOnly

public boolean isFlagOnly()

Check if property is flag only.

Returns:

true if flag-only property, false if not

genTest

public BranchWrapper genTest(ContextMethodBuilder mb)
                      throws org.jibx.runtime.JiBXException

Generate code to test if property is present. The generated code assumes that the top of the stack is the reference for the containing object, and consumes this value for the test. The target for the returned branch instruction must be set by the caller.

Parameters:

mb - method builder

Returns:

wrapper for branch instruction taken when property is missing

Throws:

org.jibx.runtime.JiBXException - If error

genFlag

public void genFlag(MethodBuilder mb)
             throws org.jibx.runtime.JiBXException

Generate code to call flag method with value on stack. The generated code assumes that the reference to the containing object and the value to be stored have already been pushed on the stack. It consumes these, leaving nothing. If the property value is not directly accessible from the context of the method being generated this automatically constructs an access method and uses that method.

Parameters:

mb - method builder

Throws:

org.jibx.runtime.JiBXException - if configuration error

genLoad

public void genLoad(ContextMethodBuilder mb)
             throws org.jibx.runtime.JiBXException

Generate code to load property value to stack. The generated code assumes that the top of the stack is the reference for the containing object. It consumes this and leaves the actual value on the stack. If the property value is not directly accessible from the context of the method being generated this automatically constructs an access method and uses that method.

Parameters:

mb - method builder

Throws:

org.jibx.runtime.JiBXException - if configuration error

genStore

public void genStore(MethodBuilder mb)
              throws org.jibx.runtime.JiBXException

Generate code to store property value from stack. The generated code assumes that the reference to the containing object and the value to be stored have already been pushed on the stack. It consumes these, leaving nothing. If the property value is not directly accessible from the context of the method being generated this automatically constructs an access method and uses that method.

Parameters:

mb - method builder

Throws:

org.jibx.runtime.JiBXException - if configuration error

toString

public String toString()

Overrides:

toString in class Object