com.exalead.mercury.mami.master.v10

Class ComponentDescription

java.lang.Object

com.exalead.mercury.mami.master.v10.ComponentDescription

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class ComponentDescription
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	author
java.lang.String	componentClassId
java.lang.String	copyright
java.lang.String	description
java.lang.String	label
java.lang.String	pluginName

Constructor Summary

Constructors

Constructor and Description
ComponentDescription()
ComponentDescription(ComponentDescription o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this ComponentDescription.
static ComponentDescription	fromString(java.lang.String s) String representation of this ComponentDescription.
java.lang.String	getAuthor() Author of the plugin, if available
java.lang.String	getComponentClassId() Class of the component
java.lang.String	getCopyright() Copyright of the plugin, if available
java.lang.String	getDescription() Description of the component, if available
java.lang.String	getLabel() Label of the component, if available
java.lang.String	getPluginName() Name of the plugin in which this component is located
ComponentDescription	makeCopy() Creates and returns a deep copy of this ComponentDescription.
static ComponentDescription	readFrom(java.io.InputStream is) Read this ComponentDescription from an XML fragment.
void	setAuthor(java.lang.String author) Author of the plugin, if available
void	setComponentClassId(java.lang.String componentClassId) Class of the component
void	setCopyright(java.lang.String copyright) Copyright of the plugin, if available
void	setDescription(java.lang.String description) Description of the component, if available
void	setLabel(java.lang.String label) Label of the component, if available
void	setPluginName(java.lang.String pluginName) Name of the plugin in which this component is located
java.lang.String	toString() String representation of this ComponentDescription.
ComponentDescription	withAuthor(java.lang.String author)
ComponentDescription	withComponentClassId(java.lang.String componentClassId)
ComponentDescription	withCopyright(java.lang.String copyright)
ComponentDescription	withDescription(java.lang.String description)
ComponentDescription	withLabel(java.lang.String label)
ComponentDescription	withPluginName(java.lang.String pluginName)
void	writeTo(java.io.OutputStream os) Write this ComponentDescription as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

componentClassId

public java.lang.String componentClassId

pluginName

public java.lang.String pluginName

label

public java.lang.String label

description

public java.lang.String description

author

public java.lang.String author

copyright

public java.lang.String copyright

Constructor Detail

ComponentDescription

public ComponentDescription()

ComponentDescription

public ComponentDescription(ComponentDescription o)

Copy constructor

Method Detail

setComponentClassId

public void setComponentClassId(java.lang.String componentClassId)

Class of the component

getComponentClassId

public java.lang.String getComponentClassId()

Class of the component

withComponentClassId

public ComponentDescription withComponentClassId(java.lang.String componentClassId)

setPluginName

public void setPluginName(java.lang.String pluginName)

Name of the plugin in which this component is located

getPluginName

public java.lang.String getPluginName()

Name of the plugin in which this component is located

withPluginName

public ComponentDescription withPluginName(java.lang.String pluginName)

setLabel

public void setLabel(java.lang.String label)

Label of the component, if available

getLabel

public java.lang.String getLabel()

Label of the component, if available

withLabel

public ComponentDescription withLabel(java.lang.String label)

setDescription

public void setDescription(java.lang.String description)

Description of the component, if available

getDescription

public java.lang.String getDescription()

Description of the component, if available

withDescription

public ComponentDescription withDescription(java.lang.String description)

setAuthor

public void setAuthor(java.lang.String author)

Author of the plugin, if available

getAuthor

public java.lang.String getAuthor()

Author of the plugin, if available

withAuthor

public ComponentDescription withAuthor(java.lang.String author)

setCopyright

public void setCopyright(java.lang.String copyright)

Copyright of the plugin, if available

getCopyright

public java.lang.String getCopyright()

Copyright of the plugin, if available

withCopyright

public ComponentDescription withCopyright(java.lang.String copyright)

makeCopy

public ComponentDescription makeCopy()

Creates and returns a deep copy of this ComponentDescription.

readFrom

public static ComponentDescription readFrom(java.io.InputStream is)
                                     throws javax.xml.bind.JAXBException

Read this ComponentDescription from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ComponentDescription as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ComponentDescription fromString(java.lang.String s)
                                       throws javax.xml.bind.JAXBException,
                                              java.io.UnsupportedEncodingException

String representation of this ComponentDescription.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ComponentDescription.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ComponentDescription.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException