Package org.jibx.binding.model
Class PropertyAttributes
java.lang.Object
org.jibx.binding.model.AttributeBase
org.jibx.binding.model.PropertyAttributes
Model component for property attribute group in binding definition.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String[]
private static final String[]
private String
Property type name.private IClassItem
Property field information.private String
Property field name.private IClassItem
Flag method information.private String
Flag method name.private IClassItem
Get method information.private String
Get method name.private IClass
Type for value loaded on stack.private boolean
Flag for no actual property definition.private IClassItem
Set method information.private String
Set method name.private IClass
Type for value stored from stack.private IClassItem
Test method information.private String
Test method name.private IClass
Property type information.private int
Usage type code.private String
Usage name.static final int
static final int
static final int
static final int
static final StringArray
Enumeration of allowed attribute namesprivate static final EnumSet
private static final String[]
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet declared type name.getField()
Get field information.Get field name.getFlag()
Get flag method information.Get flag method name.getGet()
Get get method information.Get get method name.Get type for value loaded to stack.getSet()
Get set method information.Get set method name.Get type for value stored from stack.getTest()
Get test method information.Get test method name.getType()
Get type information.int
getUsage()
Get usage value.Get usage name.boolean
Check if property is defined.boolean
Check if property consists only of flag.boolean
Check if empty property definition.void
prevalidate
(ValidationContext vctx) Prevalidate attribute information.void
setDeclaredType
(String type) Set declared type name.void
setFieldName
(String field) Set field name.void
setFlagName
(String flag) Set flag method name.void
setGetName
(String get) Set get method name.void
setSetName
(String set) Set set method name.void
setTestName
(String test) Set test method name.void
setUsage
(int use) Set usage value.void
setUsageName
(String name) Set usage name.Methods inherited from class org.jibx.binding.model.AttributeBase
validate
-
Field Details
-
s_allowedAttributes
Enumeration of allowed attribute names -
TEST_METHOD_SIGNATURES
-
FLAG_METHOD_SIGNATURES
-
GET_METHOD_SIGNATURES
-
REQUIRED_USAGE
public static final int REQUIRED_USAGE- See Also:
-
OPTIONAL_USAGE
public static final int OPTIONAL_USAGE- See Also:
-
OPTIONAL_IN_USAGE
public static final int OPTIONAL_IN_USAGE- See Also:
-
OPTIONAL_OUT_USAGE
public static final int OPTIONAL_OUT_USAGE- See Also:
-
s_usageEnum
-
m_usage
private int m_usageUsage type code. -
m_usageName
Usage name. -
m_declaredType
Property type name. -
m_fieldName
Property field name. -
m_testName
Test method name. -
m_flagName
Flag method name. -
m_getName
Get method name. -
m_setName
Set method name. -
m_getType
Type for value loaded on stack. -
m_setType
Type for value stored from stack. -
m_type
Property type information. -
m_fieldItem
Property field information. -
m_testItem
Test method information. -
m_flagItem
Flag method information. -
m_getItem
Get method information. -
m_setItem
Set method information. -
m_isImplicit
private boolean m_isImplicitFlag for no actual property definition.
-
-
Constructor Details
-
PropertyAttributes
public PropertyAttributes()
-
-
Method Details
-
getUsageName
Get usage name.- Returns:
- usage name
-
getUsage
public int getUsage()Get usage value. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- usage value
-
setUsageName
Set usage name.- Parameters:
name
- usage name
-
setUsage
public void setUsage(int use) Set usage value.- Parameters:
use
- value
-
hasProperty
public boolean hasProperty()Check if property is defined. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
true
if property defined,false
if not
-
getDeclaredType
Get declared type name.- Returns:
- declared type name (or
null
if none)
-
setDeclaredType
Set declared type name.- Parameters:
type
- declared type name (ornull
if none)
-
getFieldName
Get field name.- Returns:
- field name (or
null
if none)
-
getField
Get field information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- field information (or
null
if none)
-
setFieldName
Set field name.- Parameters:
field
- field name (ornull
if none)
-
getTestName
Get test method name.- Returns:
- test method name (or
null
if none)
-
getTest
Get test method information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- test method information (or
null
if none)
-
setTestName
Set test method name.- Parameters:
test
- test method name (ornull
if none)
-
getFlagName
Get flag method name.- Returns:
- flag method name (or
null
if none)
-
getFlag
Get flag method information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- flag method information (or
null
if none)
-
setFlagName
Set flag method name.- Parameters:
flag
- flag method name (ornull
if none)
-
getGetName
Get get method name.- Returns:
- get method name (or
null
if none)
-
getGet
Get get method information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- get method information (or
null
if none)
-
getGetType
Get type for value loaded to stack. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- get value type (or
null
if none)
-
setGetName
Set get method name.- Parameters:
get
- get method name (ornull
if none)
-
getSetName
Get set method name.- Returns:
- set method name (or
null
if none)
-
getSet
Get set method information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- set method information (or
null
if none)
-
getSetType
Get type for value stored from stack. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- set value type (or
null
if none)
-
setSetName
Set set method name.- Parameters:
set
- set method name (ornull
if none)
-
getType
Get type information. This method is only usable after a call toprevalidate(ValidationContext)
.- Returns:
- type information (or
null
if none)
-
isImplicit
public boolean isImplicit()Check if empty property definition. Empty property definitions occur because every collection, structure, and value element has associated property attributes but these may not actually reference a property (when using the containing object). This call is only meaningful after prevalidation.- Returns:
true
if implicit property,false
if not
-
isFlagOnly
public boolean isFlagOnly()Check if property consists only of flag. This call is only meaningful after prevalidation.- Returns:
true
if flag property,false
if not
-
prevalidate
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 classAttributeBase
- Parameters:
vctx
- validation context
-