Package org.jibx.binding.def
Class PropertyDefinition
java.lang.Object
org.jibx.binding.def.PropertyDefinition
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
private static final String[]
private final ClassItem
Information for field (if given, may benull
).private final ClassItem
Information for flag method (if given, may benull
).private final ClassItem
Information for get method (if given, may benull
).private final String
Fully qualified name of declared type of value loaded.private boolean
Reference to implicit value from collection.private boolean
Optional item flag.private boolean
Reference to "this" property of object flag.private final IContextObj
Containing object context.private final ClassItem
Information for set method (if given, may benull
).private final String
Fully qualified name of declared type of value stored.private final ClassItem
Information for test method (if given, may benull
).private final String
Fully qualified name of actual type of value.private static final String[]
-
Constructor Summary
ConstructorsConstructorDescriptionPropertyDefinition
(String type, IContextObj obj, boolean opt) Constructor for implicit object reference.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. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Append instruction to pop the value from the stack.private void
Append instruction to duplicate the value on the stack.void
genFlag
(MethodBuilder mb) Generate code to call flag method with value on stack.void
Generate code to load property value to stack.void
Generate code to store property value from stack.Generate code to test if property is present.Get value type as fully qualified name for loaded property value.getName()
Get property name.Get value type as fully qualified name for stored property value.Get declared type fully qualified name.boolean
hasFlag()
Check if property has flag method.boolean
hasTest()
Check if property has presence test.boolean
Check if property is flag only.boolean
Check if property is implicit value from collection.boolean
Check if the value can be loaded.boolean
Check if property is optional.boolean
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
Switch property from "this" to "implicit".toString()
-
Field Details
-
TEST_METHOD_SIGNATURES
-
GET_METHOD_SIGNATURES
-
FLAG_METHOD_SIGNATURES
-
m_isThis
private boolean m_isThisReference to "this" property of object flag. -
m_isImplicit
private boolean m_isImplicitReference to implicit value from collection. -
m_isOptional
private boolean m_isOptionalOptional item flag. -
m_objContext
Containing object context. -
m_typeName
Fully qualified name of actual type of value. -
m_getValueType
Fully qualified name of declared type of value loaded. -
m_setValueType
Fully qualified name of declared type of value stored. -
m_fieldItem
Information for field (if given, may benull
). -
m_testMethod
Information for test method (if given, may benull
). -
m_flagMethod
Information for flag method (if given, may benull
). -
m_getMethod
Information for get method (if given, may benull
). -
m_setMethod
Information for set method (if given, may benull
).
-
-
Constructor Details
-
PropertyDefinition
public PropertyDefinition(IContainer parent, IContextObj obj, String type, boolean isthis, boolean opt, String fname, String test, String flag, String get, String set) throws JiBXException Constructor.- Parameters:
parent
- containing binding definition structureobj
- containing object contexttype
- fully qualified name of typeisthis
- "this" object reference flagopt
- optional property flagfname
- containing object field name for property (may benull
)test
- containing object method to test for property present (may benull
)flag
- containing object method to flag property present (may benull
)get
- containing object method to get property value (may benull
)set
- containing object method to set property value (may benull
)- Throws:
JiBXException
- if configuration error
-
PropertyDefinition
Constructor for "this" object reference.- Parameters:
obj
- containing object contextopt
- optional property flag
-
PropertyDefinition
Constructor for implicit object reference.- Parameters:
type
- object type suppliedobj
- containing object contextopt
- optional property flag
-
PropertyDefinition
Copy constructor.- Parameters:
original
-
-
-
Method Details
-
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
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
Get declared type fully qualified name.- Returns:
- fully qualified class name of declared type
-
getGetValueType
Get value type as fully qualified name for loaded property value.- Returns:
- fully qualified class name of value type
-
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
-
duplicateValue
Append instruction to duplicate the value on the stack. This will use the appropriate instruction for the size of the value.- Parameters:
mb
-
-
discardValue
Append instruction to pop the value from the stack. This will use the appropriate instruction for the size of the value.- Parameters:
mb
-
-
genTest
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:
JiBXException
-
genFlag
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:
JiBXException
- if configuration error
-
genLoad
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:
JiBXException
- if configuration error
-
genStore
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:
JiBXException
- if configuration error
-
toString
-