Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.descriptor.beangen
Class PropertyDeclaration

java.lang.Object
  extended by weblogic.descriptor.beangen.BeanElement
      extended by weblogic.descriptor.beangen.PropertyDeclaration
All Implemented Interfaces:
Comparable

public class PropertyDeclaration
extends BeanElement
implements Comparable

A BeanProperty represents the logical property that is inferred from a certain collection of methods in the bean interface. If an interface defines a getter (see PropertyMethodType.GETTER, it implicitly defines an property. The qualities of that property are further qualified by the presence of additional methods that operate on that property.


Method Summary
 boolean arrayOrderSensitive()
           
 int compareTo(Object o)
          Sort based on getter.
 boolean equals(Object o)
           
 String getAbsoluteType()
           
protected  String[] getAllAnnotationNames()
          Avoid using this method.
 JAnnotationValue getAnnotationValue(AnnotationDefinition tag)
           
 String getComponentImplType()
          Attempts to derive the implementation class name corresponding to the component type.
protected  JClass getComponentJClass()
           
 String getComponentName()
          Return the name of a component of this property if the property represents a list.name if property is a list.
 String getComponentType()
           
 String getDecapitalizedName()
           
 String getDefault()
           
 PropertyDeclaration getDelegatedProperty()
           
 String getDeprecatedString()
           
 String getDerivedDefault()
           
 String getElementNameAnnotation()
           
 int getIndex()
           
 String getInitializer()
           
 JClass getJClass()
           
 String getJClassAnnotationString(String name)
           
 String getLegalValues()
           
 String getName()
           
 PostGenValidation[] getPostGenValidations()
           
 String getRemoveValidator()
           
 String getType()
           
 String getValueFromString(String arg)
           
 String getXMLElementName()
          Return XML element name
 boolean hasAddressableComponents()
           
 boolean hasAnnotationListener()
           
 boolean hasComponents()
          Deprecated. Use hasAddressableComponents instead
 int hashCode()
           
 boolean hasRestrictiveAccess()
           
 boolean hasTransientOverride()
           
 boolean isAnnotationDefinedOnPropertyInterface(String name)
           
 boolean isArray()
           
 boolean isAttribute()
          Return true iff the property is adorned with the attribute annotation, indicating that it is implemented in the XML schema as an attribute, as opposed to an element.
 boolean isBean()
          Returns true if this property is a desriptor bean or an array (or list of) desciptor beans.
 boolean isChild()
           
 boolean isConfigurable()
           
 boolean isDeclaredEncrypted()
           
 boolean isDynamic()
           
 boolean isExcludedFromSchema()
           
 boolean isKey()
           
 boolean isKeyChoice()
           
 boolean isKeyComponent()
           
 boolean isMergeRuleIgnoreSourceDefined()
           
 boolean isMergeRuleIgnoreTargetDefined()
           
 boolean isMergeRulePrependDefined()
           
 boolean isPreviouslyPersisted()
           
 boolean isReadOnly()
           
 boolean isReference()
           
 boolean isReferenceable()
           
 boolean isRequired()
           
 boolean isSuperProperty()
          Deprecated. only used to generate 8.1 config.xml parser
 boolean isTransient()
           
 boolean needsPostGenValidation()
           
 void setDelegatedProperty(PropertyDeclaration p)
           
 void setRestrictiveAccess()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public String getName()
Returns:
name of property

getDecapitalizedName

public String getDecapitalizedName()
Returns:
name of property decapitalized for JavaBean compliance

getType

public String getType()
Returns:
type of property

getIndex

public int getIndex()

isBean

public boolean isBean()
Returns true if this property is a desriptor bean or an array (or list of) desciptor beans. An object is considered a descriptor bean if it either if declares the wld:bean annotation or is a sub-interface of Context.getBaseBeanInterface().

Returns:
true if this property is or contains a desriptor bean

isSuperProperty

public boolean isSuperProperty()
Deprecated. only used to generate 8.1 config.xml parser

Returns:
true if this property may hold values that are subtypes of its type.

isChild

public boolean isChild()
Returns:
true if this property is a child of its containing bean.

isReferenceable

public boolean isReferenceable()

isReadOnly

public boolean isReadOnly()
Returns:
true if no mutators are defined for this property

isReference

public boolean isReference()
Returns:
true if this property is a bean that is not a child

isDeclaredEncrypted

public boolean isDeclaredEncrypted()
Returns:
true if encryption code needs to be generated for this property

isTransient

public boolean isTransient()
Returns:
true if the annotation 'transient' is defined or if the propoerty has annotation 'encrypted' defined

isPreviouslyPersisted

public boolean isPreviouslyPersisted()
Returns:
true if 'encrypted' annotation is defined or if an 'previously persisted' annotation has been defined

isExcludedFromSchema

public boolean isExcludedFromSchema()

getInitializer

public String getInitializer()

isArray

public boolean isArray()
Returns:
true if that property is an array

hasAddressableComponents

public boolean hasAddressableComponents()
Returns:
true if this property is an array that provides access to its components

hasComponents

public boolean hasComponents()
Deprecated. Use hasAddressableComponents instead


getComponentImplType

public String getComponentImplType()
Attempts to derive the implementation class name corresponding to the component type.

For example, if PropertyDeclaration.getComponentType() returns "weblogic.management.configuration.DomainMBean", and beangen has been told to use a package suffix of "beanimpl" and a suffix of "Impl", this method should return "weblogic.management.configuration.beanimpl.DomainMBeanImpl".


getComponentType

public String getComponentType()
Returns:
type of component if property is an array. Otherwise type of property.

getComponentJClass

protected JClass getComponentJClass()
Returns:
type of component if property is an array. Otherwise type of property.

getAbsoluteType

public String getAbsoluteType()

getComponentName

public String getComponentName()
Return the name of a component of this property if the property represents a list.name if property is a list. If the property name is plural, return the singular (e.g., Popsicles -> Popsicle); if the name ends with "List", return the name with "List" removed (e.g., PopsicleList -> Popsicle). Return the value of @component-name annotatation if that annotation is specified.

Returns:
name of component if property is a list; otherwise the name of the property.

getAnnotationValue

public JAnnotationValue getAnnotationValue(AnnotationDefinition tag)
Overrides:
getAnnotationValue in class BeanElement

getDelegatedProperty

public PropertyDeclaration getDelegatedProperty()

setDelegatedProperty

public void setDelegatedProperty(PropertyDeclaration p)

getAllAnnotationNames

protected String[] getAllAnnotationNames()
Avoid using this method. It maybe discontinued in future

Overrides:
getAllAnnotationNames in class BeanElement

getJClass

public JClass getJClass()

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(Object o)
Sort based on getter.

Specified by:
compareTo in interface Comparable

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hasTransientOverride

public boolean hasTransientOverride()

getValueFromString

public String getValueFromString(String arg)

getElementNameAnnotation

public String getElementNameAnnotation()

getXMLElementName

public String getXMLElementName()
Return XML element name


isDynamic

public boolean isDynamic()

isAttribute

public boolean isAttribute()
Return true iff the property is adorned with the attribute annotation, indicating that it is implemented in the XML schema as an attribute, as opposed to an element.


getDefault

public String getDefault()

getLegalValues

public String getLegalValues()

getDerivedDefault

public String getDerivedDefault()

getRemoveValidator

public String getRemoveValidator()

isRequired

public boolean isRequired()

isConfigurable

public boolean isConfigurable()

isKey

public boolean isKey()

isKeyChoice

public boolean isKeyChoice()

isKeyComponent

public boolean isKeyComponent()

arrayOrderSensitive

public boolean arrayOrderSensitive()

isMergeRuleIgnoreSourceDefined

public boolean isMergeRuleIgnoreSourceDefined()

isMergeRuleIgnoreTargetDefined

public boolean isMergeRuleIgnoreTargetDefined()

isMergeRulePrependDefined

public boolean isMergeRulePrependDefined()

hasAnnotationListener

public boolean hasAnnotationListener()

needsPostGenValidation

public boolean needsPostGenValidation()

getPostGenValidations

public PostGenValidation[] getPostGenValidations()

setRestrictiveAccess

public void setRestrictiveAccess()

hasRestrictiveAccess

public boolean hasRestrictiveAccess()

getDeprecatedString

public String getDeprecatedString()

getJClassAnnotationString

public String getJClassAnnotationString(String name)

isAnnotationDefinedOnPropertyInterface

public boolean isAnnotationDefinedOnPropertyInterface(String name)

Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02