com.codemonster.surinam.core.framework.injection
Class PropertyBase

java.lang.Object
  extended by com.codemonster.surinam.core.framework.injection.PropertyBase
All Implemented Interfaces:
ServiceProperty
Direct Known Subclasses:
ArrayProperty, InjectedList, InjectedMap, InjectedProperty

public abstract class PropertyBase
extends Object
implements ServiceProperty

This abstract base class encapsulates common attributes for all properties.


Constructor Summary
PropertyBase()
           
 
Method Summary
 String getMethod()
           
 String getName()
          The name field is synonymous with the attribute name on a service.
static String getTabValue()
           
 void setMethod(String method)
           
 void setName(String name)
           
static void setTabValue(String tabValue)
           
 void setXmlIndentation(int xmlIndentation)
           
 void setXmlIndentation(String xmlIndentation)
           
abstract  String toXML()
          Putting this method here will make it clear that while it is required by the interface, we expect subclasses to provide the appropriate implementations.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyBase

public PropertyBase()
Method Detail

getName

public String getName()
Description copied from interface: ServiceProperty
The name field is synonymous with the attribute name on a service.

Specified by:
getName in interface ServiceProperty
Returns:
returns the name of the attribute.

setName

public void setName(String name)

getMethod

public String getMethod()
Specified by:
getMethod in interface ServiceProperty
Returns:
Returns the name of the method to use as the object setter; it must conform to the standard signature for setters.

setMethod

public void setMethod(String method)

setXmlIndentation

public void setXmlIndentation(String xmlIndentation)
Specified by:
setXmlIndentation in interface ServiceProperty
Parameters:
xmlIndentation - This allows a caller to set an indentation string that will be applied to the lines of XML generated to represent this property.

setXmlIndentation

public void setXmlIndentation(int xmlIndentation)
Parameters:
xmlIndentation - The number of indent places (tabs) for the rendered XML.

getTabValue

public static String getTabValue()

setTabValue

public static void setTabValue(String tabValue)

toXML

public abstract String toXML()
Putting this method here will make it clear that while it is required by the interface, we expect subclasses to provide the appropriate implementations. This is important as these classes will be used when generating new Action Documents.

Specified by:
toXML in interface ServiceProperty
Returns:
Returns the XML form of this property.


Copyright © 2010. All Rights Reserved.