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