Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.ws.jaxme.generator.sg

Interface PropertySG

Known Implementing Classes:
PropertySGImpl
public interface PropertySG
Author:
Jochen Wiedmann

Method Summary

void
addValue(JavaMethod pMethod, DirectAccessible pElement, TypedValue pValue, JavaQName pType)
Creates a piece of Java code adding an element value.
void
forAllNonNullValues(JavaMethod pMethod, DirectAccessible pElement, SGlet pSGlet)
Invokes the given SGlet for any non null value.
void
forAllValues(JavaMethod pMethod, DirectAccessible pElement, SGlet pSGlet)
Invokes the given SGlet for any value.
void
generate(JavaSource pSource)
Generates the property setters and getters.
String
getCollectionType()
Returns the properties collection type.
String
getPropertyName()
Returns the objects property name.
Object
getValue(DirectAccessible pElement)
Returns a piece of Java code with the property value.
JavaField
getXMLField(JavaSource pSource)
Creates the Java field holding the objects property value.
String
getXMLFieldName()
Returns the objects field name.
JavaMethod
getXMLGetMethod(JavaSource pSource)
Creates the getter returning the property value.
String
getXMLGetMethodName()
Returns the objects getter name.
JavaMethod
getXMLIsSetMethod(JavaSource pSource)
Creates the isSet returning whether the property value is set or not.
String
getXMLIsSetMethodName()
Returns the name of the objects "isSet" method.
JavaMethod
getXMLSetMethod(JavaSource pSource)
Creates the setter returning the property value.
String
getXMLSetMethodName()
Returns the objects setter name.
boolean
hasIsSetMethod()
Returns whether the property has an "is set" method.
void
init()
Initializes the PropertySG.
void
setValue(JavaMethod pMethod, DirectAccessible pElement, Object pValue, JavaQName pType)
Creates a piece of Java code setting the elements property value.

Method Details

addValue

public void addValue(JavaMethod pMethod,
                     DirectAccessible pElement,
                     TypedValue pValue,
                     JavaQName pType)
            throws SAXException
Creates a piece of Java code adding an element value. In the case of an element with multiplicity > 1, the object must be the atomic value.
Parameters:
pElement - The element on which the value is being set or null for "this".
pType - The values type, if a cast is required, or null, if the value is already casted.

forAllNonNullValues

public void forAllNonNullValues(JavaMethod pMethod,
                                DirectAccessible pElement,
                                SGlet pSGlet)
            throws SAXException
Invokes the given SGlet for any non null value.
Parameters:
pElement - The element on which the value is being set or null for "this".

forAllValues

public void forAllValues(JavaMethod pMethod,
                         DirectAccessible pElement,
                         SGlet pSGlet)
            throws SAXException
Invokes the given SGlet for any value.
Parameters:
pElement - The element on which the value is being set or null for "this".

generate

public void generate(JavaSource pSource)
            throws SAXException
Generates the property setters and getters.

getCollectionType

public String getCollectionType()
Returns the properties collection type.

getPropertyName

public String getPropertyName()
            throws SAXException
Returns the objects property name.

getValue

public Object getValue(DirectAccessible pElement)
            throws SAXException
Returns a piece of Java code with the property value.
Parameters:
pElement - The element on which the value is being set or null for "this".

getXMLField

public JavaField getXMLField(JavaSource pSource)
            throws SAXException
Creates the Java field holding the objects property value.

getXMLFieldName

public String getXMLFieldName()
            throws SAXException
Returns the objects field name. By default, this is the property name with the prefix '_'.

getXMLGetMethod

public JavaMethod getXMLGetMethod(JavaSource pSource)
            throws SAXException
Creates the getter returning the property value.

getXMLGetMethodName

public String getXMLGetMethodName()
            throws SAXException
Returns the objects getter name.

getXMLIsSetMethod

public JavaMethod getXMLIsSetMethod(JavaSource pSource)
            throws SAXException
Creates the isSet returning whether the property value is set or not.

getXMLIsSetMethodName

public String getXMLIsSetMethodName()
            throws SAXException
Returns the name of the objects "isSet" method.

getXMLSetMethod

public JavaMethod getXMLSetMethod(JavaSource pSource)
            throws SAXException
Creates the setter returning the property value.

getXMLSetMethodName

public String getXMLSetMethodName()
            throws SAXException
Returns the objects setter name.

hasIsSetMethod

public boolean hasIsSetMethod()
Returns whether the property has an "is set" method.

init

public void init()
            throws SAXException
Initializes the PropertySG.

setValue

public void setValue(JavaMethod pMethod,
                     DirectAccessible pElement,
                     Object pValue,
                     JavaQName pType)
            throws SAXException
Creates a piece of Java code setting the elements property value. In the case of an element with multiplicity > 1, the object must be a list or an array.
Parameters:
pMethod - The method being generated.
pElement - The element on which the value is being set or null for "this".
pType - The values type, if a cast is required, or null, if the value is already casted.

Overview Package Tree Index Deprecated About