|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.hyades.logging.events.cbe.util.EventFormatter
The EventFormatter
class defines a utility object used for
converting, serializing and de-serializing CommonBaseEvent
and
related objects.
Notes:
serialize()
APIs in the org.eclipse.hyades.logging.core.XmlUtility
class.
org.eclipse.hyades.logging.events.cbe.impl.CommonBaseEvent
,
org.eclipse.hyades.logging.events.cbe.impl.AssociationEngine
,
SAXEventHandler
Constructor Summary | |
---|---|
EventFormatter()
|
Method Summary | |
---|---|
static AssociationEngine |
associationEngineFromCanonicalXML(java.lang.String xmlString)
Converts an XML fragment to an AssociationEngine object. |
static AssociationEngine[] |
associationEnginesFromCanonicalXMLDoc(java.io.File file)
Converts an XML document from an File to an array of
AssociationEngine objects. |
static AssociationEngine[] |
associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)
Converts an XML document from an InputSource to an array of
AssociationEngine objects. |
static AssociationEngine[] |
associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream)
Converts an XML document from an InputStream to an array of
AssociationEngine objects. |
static AssociationEngine[] |
associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocString)
Converts an XML document to an array of AssociationEngine objects. |
static CommonBaseEvent |
eventFromCanonicalXML(java.lang.String xmlString)
Converts an XML fragment to an CommonBaseEvent object. |
static CommonBaseEvent[] |
eventsFromCanonicalXMLDoc(java.io.File file)
Converts an XML document from an File to an array of
CommonBaseEvent objects. |
static CommonBaseEvent[] |
eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)
Converts an XML document from an InputSource to an array of
CommonBaseEvent objects. |
static CommonBaseEvent[] |
eventsFromCanonicalXMLDoc(java.io.InputStream inputStream)
Converts an XML document from an InputStream to an array of
CommonBaseEvent objects. |
static CommonBaseEvent[] |
eventsFromCanonicalXMLDoc(java.lang.String xmlDocString)
Converts an XML document to an array of CommonBaseEvent objects. |
static void |
fromCanonicalXMLDocString(AssociationEngine associationEngine,
java.lang.String xmlDocString)
Deprecated. Use associationEnginesFromCanonicalXMLDoc(String) . |
static void |
fromCanonicalXMLDocString(CommonBaseEvent commonBaseEvent,
java.lang.String xmlDocString)
Deprecated. Use eventsFromCanonicalXMLDoc(String) . |
static void |
fromCanonicalXMLString(AssociationEngine associationEngine,
java.lang.String xmlString)
Deprecated. Use associationEngineFromCanonicalXML(String) . |
static void |
fromCanonicalXMLString(CommonBaseEvent commonBaseEvent,
java.lang.String xmlString)
Deprecated. Use eventFromCanonicalXML(String) . |
static java.lang.String |
toCanonicalXMLDocString(AssociationEngine associationEngine)
Converts an AssociationEngine object into a formatted serialized
XML document. |
static java.lang.String |
toCanonicalXMLDocString(AssociationEngine associationEngine,
boolean format)
Converts an AssociationEngine object into a serialized
XML document. |
static java.lang.String |
toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent)
Converts an CommonBaseEvent object into a formatted serialized
XML document. |
static java.lang.String |
toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent,
boolean format)
Converts an CommonBaseEvent object into a serialized
XML document. |
static java.lang.String |
toCanonicalXMLString(AssociationEngine associationEngine)
Converts an AssociationEngine object into a serialized
XML fragment. |
static java.lang.String |
toCanonicalXMLString(CommonBaseEvent commonBaseEvent)
Converts an CommonBaseEvent object into a formatted serialized
XML fragment. |
static java.lang.String |
toCanonicalXMLString(CommonBaseEvent commonBaseEvent,
boolean format)
Converts an CommonBaseEvent object into a serialized
XML fragment. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public EventFormatter()
Method Detail |
public static java.lang.String toCanonicalXMLDocString(AssociationEngine associationEngine)
AssociationEngine
object into a formatted serialized
XML document.
associationEngine
- The AssociationEngine
to serialize.
AssociationEngine
object.public static java.lang.String toCanonicalXMLDocString(AssociationEngine associationEngine, boolean format)
AssociationEngine
object into a serialized
XML document. Formatting is based on the format parameter.
associationEngine
- The AssociationEngine
to serialize.format
- If the serialized XML document is formatted with platform-dependent new line(s) and tab(s).
AssociationEngine
object.public static java.lang.String toCanonicalXMLString(AssociationEngine associationEngine)
AssociationEngine
object into a serialized
XML fragment.
associationEngine
- The AssociationEngine
to serialize.
AssociationEngine
object.public static void fromCanonicalXMLDocString(AssociationEngine associationEngine, java.lang.String xmlDocString)
associationEnginesFromCanonicalXMLDoc(String)
.
AssociationEngine
object.
associationEngine
- The AssociationEngine
object to populate.xmlDocString
- The XML document containing the information used to populate the AssociationEngine
object.public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocString) throws FormattingException
AssociationEngine
objects.
xmlDocString
- The XML document to populate the AssociationEngine
object.
AssociationEngine
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource) throws FormattingException
InputSource
to an array of
AssociationEngine
objects.
AssociationEngine
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream) throws FormattingException
InputStream
to an array of
AssociationEngine
objects.
AssociationEngine
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.File file) throws FormattingException
File
to an array of
AssociationEngine
objects.
AssociationEngine
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static void fromCanonicalXMLString(AssociationEngine associationEngine, java.lang.String xmlString)
associationEngineFromCanonicalXML(String)
.
AssociationEngine
object.
associationEngine
- The AssociationEngine
object to populate.xmlString
- The XML fragment containing the information used to populate the AssociationEngine
object.public static AssociationEngine associationEngineFromCanonicalXML(java.lang.String xmlString) throws FormattingException
AssociationEngine
object.
xmlString
- The XML fragment to populate the AssociationEngine
object.
AssociationEngine
to be populated by the XML fragment.
FormattingException
- A de-serialization error has occurred.public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent)
CommonBaseEvent
object into a formatted serialized
XML document.
commonBaseEvent
- The CommonBaseEvent
to serialize.
CommonBaseEvent
object.public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent, boolean format)
CommonBaseEvent
object into a serialized
XML document. Formatting is based on the format parameter.
commonBaseEvent
- The CommonBaseEvent
to serialize.format
- If the serialized XML document is formatted with platform-dependent new line(s) and tab(s).
CommonBaseEvent
object.public static java.lang.String toCanonicalXMLString(CommonBaseEvent commonBaseEvent)
CommonBaseEvent
object into a formatted serialized
XML fragment.
commonBaseEvent
- The CommonBaseEvent
to serialize.
CommonBaseEvent
object.public static java.lang.String toCanonicalXMLString(CommonBaseEvent commonBaseEvent, boolean format)
CommonBaseEvent
object into a serialized
XML fragment. Formatting is based on the format parameter.
commonBaseEvent
- The CommonBaseEvent
to serialize.format
- If the serialized XML fragment is formatted with platform-dependent new line(s) and tab(s).
CommonBaseEvent
object.public static void fromCanonicalXMLDocString(CommonBaseEvent commonBaseEvent, java.lang.String xmlDocString)
eventsFromCanonicalXMLDoc(String)
.
CommonBaseEvent
object.
If the XML document contains more than one CommonBaseEvent
element,
the first CommonBaseEvent
element if used.
commonBaseEvent
- The CommonBaseEvent
to be populated by the XML document.xmlDocString
- The XML document to populate the CommonBaseEvent
object.public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.lang.String xmlDocString) throws FormattingException
CommonBaseEvent
objects.
xmlDocString
- The XML document to populate the CommonBaseEvent
object.
CommonBaseEvent
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource) throws FormattingException
InputSource
to an array of
CommonBaseEvent
objects.
CommonBaseEvent
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.InputStream inputStream) throws FormattingException
InputStream
to an array of
CommonBaseEvent
objects.
CommonBaseEvent
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.File file) throws FormattingException
File
to an array of
CommonBaseEvent
objects.
CommonBaseEvent
s array to be populated by the XML document.
FormattingException
- A de-serialization error has occurred.public static void fromCanonicalXMLString(CommonBaseEvent commonBaseEvent, java.lang.String xmlString)
eventFromCanonicalXML(String)
.
CommonBaseEvent
object.
commonBaseEvent
- The CommonBaseEvent
to be populated by the XML fragment.xmlString
- The XML fragment to populate the CommonBaseEvent
object.public static CommonBaseEvent eventFromCanonicalXML(java.lang.String xmlString) throws FormattingException
CommonBaseEvent
object.
xmlString
- The XML fragment to populate the CommonBaseEvent
object.
CommonBaseEvent
to be populated by the XML fragment.
FormattingException
- A de-serialization error has occurred.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |