org.objectweb.jonas_lib.deployment.api
Class DescriptionGroupDesc

java.lang.Object
  org.objectweb.jonas_lib.deployment.api.DescriptionGroupDesc

All Implemented Interfaces:

DescriptionGroup

Direct Known Subclasses:

DeploymentDesc, JndiEnvRefsGroupDesc

public abstract class DescriptionGroupDesc
extends java.lang.Object
implements DescriptionGroup

This class is used to keep the usage of the contained description related elements consistent acoross J2EE deployment descriptors. Elements are "description", "display-name", "icon" used by application, connector, ejb-jar, webservices.

Author:

Philippe Coq

Field Summary

protected java.lang.String	description The description field
protected java.lang.String	displayName The displayName field
protected java.lang.String	largeIcon The large-icon field
protected java.lang.String	smallIcon The small-icon field

Constructor Summary

DescriptionGroupDesc()

Method Summary

java.lang.String	getDescription() Get the description of the deployment descriptor.
java.lang.String	getDisplayName() Get the display name of the deployment descriptor.
java.lang.String	getLargeIcon() Get the large-icon of the deployment descriptor.
protected static java.lang.String	getSAXMsg(java.lang.String fileName, org.xml.sax.SAXParseException exception, java.lang.String msg) build a message from SAX Exception in a consistent style, consistent with emacs compile mode (same as grep, cc, javac, etc).
java.lang.String	getSmallIcon() Get the small-icon of the deployment descriptor.
abstract java.lang.String	toString() Return a String representation of the DeploymentDesc.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected java.lang.String description

The description field

displayName

protected java.lang.String displayName

The displayName field

smallIcon

protected java.lang.String smallIcon

The small-icon field

largeIcon

protected java.lang.String largeIcon

The large-icon field

Constructor Detail

DescriptionGroupDesc

public DescriptionGroupDesc()

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Get the display name of the deployment descriptor.

Specified by:

getDisplayName in interface DescriptionGroup

Returns:

the display name of the deployment descriptor.

getDescription

public java.lang.String getDescription()

Get the description of the deployment descriptor.

Specified by:

getDescription in interface DescriptionGroup

Returns:

the description of the deployment descriptor.

getSmallIcon

public java.lang.String getSmallIcon()

Get the small-icon of the deployment descriptor.

Specified by:

getSmallIcon in interface DescriptionGroup

Returns:

the small-icon of the deployment descriptor.

getLargeIcon

public java.lang.String getLargeIcon()

Get the large-icon of the deployment descriptor.

Specified by:

getLargeIcon in interface DescriptionGroup

Returns:

the large-icon of the deployment descriptor.

toString

public abstract java.lang.String toString()

Return a String representation of the DeploymentDesc.

Specified by:

toString in interface DescriptionGroup

Overrides:

toString in class java.lang.Object

Returns:

a String representation of the DeploymentDesc.

getSAXMsg

protected static java.lang.String getSAXMsg(java.lang.String fileName,
                                            org.xml.sax.SAXParseException exception,
                                            java.lang.String msg)

build a message from SAX Exception in a consistent style, consistent with emacs compile mode (same as grep, cc, javac, etc).

Parameters:

fileName - name of the file

exception - the SAX exception

msg - the string message

Returns:

a message which is in a consistent style