COM.TIBCO.hawk.config.rbengine.util

Class MicroAgentDescriptorXML

java.lang.Object

COM.TIBCO.hawk.config.rbengine.util.MicroAgentDescriptorXML

public class MicroAgentDescriptorXML
extends java.lang.Object

This class allow a MicroAgentDescriptor to be exported and restored from its XML representation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CNAME

Constructor Summary

Constructors

Constructor and Description
MicroAgentDescriptorXML()

Method Summary

Modifier and Type	Method and Description
static COM.TIBCO.hawk.talon.MicroAgentDescriptor	fromXML(java.io.Reader reader) Returns a MicroAgentDescriptor object from a Reader.
static COM.TIBCO.hawk.talon.MicroAgentDescriptor	restoreFromFile(java.lang.String fileName) Restore a MicroAgentDescriptor from a file.
static void	saveToPath(java.lang.String path, COM.TIBCO.hawk.talon.MicroAgentDescriptor mad) Save the MicroAgentDescriptor to a file in the given path.
static java.lang.String	toXML(COM.TIBCO.hawk.talon.MicroAgentDescriptor mad) Returns the XML representation of the specified MicroAgentDescriptor.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CNAME

public static java.lang.String CNAME

Constructor Detail

MicroAgentDescriptorXML

public MicroAgentDescriptorXML()

Method Detail

toXML

public static java.lang.String toXML(COM.TIBCO.hawk.talon.MicroAgentDescriptor mad)
                              throws java.io.IOException

Returns the XML representation of the specified MicroAgentDescriptor.

Parameters:

mad - The MicroAgentDescriptor to obtain the XML representation.

Throws:

java.io.IOException

saveToPath

public static void saveToPath(java.lang.String path,
                              COM.TIBCO.hawk.talon.MicroAgentDescriptor mad)
                       throws java.io.IOException,
                              java.lang.ClassNotFoundException

Save the MicroAgentDescriptor to a file in the given path.

Parameters:

path - The path where the MicroAgentDescriptor's XML representation is written to. The name of the file created is obtain from the method getDisplayName() of the MicroAgentDescriptor.

mad - The MicroAgentDescriptor to be written.

Throws:

java.io.IOException

java.lang.ClassNotFoundException

fromXML

public static COM.TIBCO.hawk.talon.MicroAgentDescriptor fromXML(java.io.Reader reader)
                                                         throws java.io.IOException

Returns a MicroAgentDescriptor object from a Reader.

Parameters:

reader - The reader that the XML representation the MicroAgentDescriptor object.

Throws:

java.io.IOException

restoreFromFile

public static COM.TIBCO.hawk.talon.MicroAgentDescriptor restoreFromFile(java.lang.String fileName)
                                                                 throws java.io.FileNotFoundException,
                                                                        java.io.IOException

Restore a MicroAgentDescriptor from a file.

Parameters:

fileName - The fileName of the file that caontain the XML representation of the MicroAgentDescriptor.

Throws:

java.io.FileNotFoundException

java.io.IOException