|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.zeus.Marshaller
Marshaller
takes a Java Object
instance and writes
out an XML representation of that object, with each property (variable)
of the instance and its value.
Field Summary | |
static boolean |
DEBUG
Constant used to signel whether debug messages should be printed out |
protected java.lang.String |
namePrefix
Prefix to be prepended to the name of every generated interface and class. |
Constructor Summary | |
Marshaller()
Simple constructor. |
Method Summary | |
java.lang.String |
getNamePrefix()
This method allows the developer to get the prefix that will be prepended to the name of every generated interface and class. |
void |
ignoreMethod(java.lang.String methodToIgnore)
This will set an (additional) method to ignore in marshalling. |
void |
marshal(java.lang.Object obj,
Result result)
This method is the public entry point for marshalling an object into an XML instance document. |
void |
marshal(UnmarshalledObject obj,
Result result)
This method is the public entry point for marshalling an object into an XML instance document. |
void |
setNamePrefix(java.lang.String namePrefix)
This method allows the developer to set a prefix that will be prepended to the name of every generated interface and class. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static boolean DEBUG
protected java.lang.String namePrefix
Constructor Detail |
public Marshaller()
Simple constructor.
Method Detail |
public void ignoreMethod(java.lang.String methodToIgnore)
This will set an (additional) method to ignore in marshalling. The argument to this method should be the method name to ignore, without arguments or parenthesis. To ignore the method "getFactory()", the value would simply be "getFactory" for this method.
methodToIgnore
- name of method to ignore.public void setNamePrefix(java.lang.String namePrefix)
This method allows the developer to set a prefix that will be prepended to the name of every generated interface and class.
String
- prefix that will be prepended to the
name of every generated interface and classpublic java.lang.String getNamePrefix()
This method allows the developer to get the prefix that will be prepended to the name of every generated interface and class. Returns an empty string in the case that a prefix is not prepended.
String
prefix that will be prepended
to the name of every generated interface and classpublic void marshal(java.lang.Object obj, Result result) throws java.io.IOException
This method is the public entry point for marshalling an object into an XML instance document.
obj
- Object
to convert to XML.result
- Result
to write XML to.IOException
- when errors in output occur.public void marshal(UnmarshalledObject obj, Result result) throws java.io.IOException
This method is the public entry point for marshalling an object into
an XML instance document. It requires that an object previously
unmarshalled by Zeus (an instance of UnmarshalledObject
)
be supplied.
obj
- UnmarshalledObject
to convert to XML.result
- Result
to write XML to.IOException
- when errors in output occur.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |