org.ow2.jonas.deployment.common
Class DescriptionGroupDesc

java.lang.Object
  org.ow2.jonas.deployment.common.DescriptionGroupDesc

All Implemented Interfaces:

IDescriptionGroupDesc

Direct Known Subclasses:

DeploymentDesc, JndiEnvRefsGroupDesc

public abstract class DescriptionGroupDesc
extends Object
implements IDescriptionGroupDesc

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 String	description The description field
protected String	displayName The displayName field
protected String	largeIcon The large-icon field
protected String	smallIcon The small-icon field

Constructor Summary

DescriptionGroupDesc()

Method Summary

String	getDescription() Get the description of the deployment descriptor.
String	getDisplayName() Get the display name of the deployment descriptor.
String	getLargeIcon() Get the large-icon of the deployment descriptor.
protected static String	getSAXMsg(String fileName, SAXParseException exception, String msg) build a message from SAX Exception in a consistent style, consistent with emacs compile mode (same as grep, cc, javac, etc).
String	getSmallIcon() Get the small-icon of the deployment descriptor.
abstract 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 String description

The description field

displayName

protected String displayName

The displayName field

smallIcon

protected String smallIcon

The small-icon field

largeIcon

protected String largeIcon

The large-icon field

Constructor Detail

DescriptionGroupDesc

public DescriptionGroupDesc()

Method Detail

getDisplayName

public String getDisplayName()

Get the display name of the deployment descriptor.

Specified by:

getDisplayName in interface IDescriptionGroupDesc

Returns:

the display name of the deployment descriptor.

getDescription

public String getDescription()

Get the description of the deployment descriptor.

Specified by:

getDescription in interface IDescriptionGroupDesc

Returns:

the description of the deployment descriptor.

getSmallIcon

public String getSmallIcon()

Get the small-icon of the deployment descriptor.

Specified by:

getSmallIcon in interface IDescriptionGroupDesc

Returns:

the small-icon of the deployment descriptor.

getLargeIcon

public String getLargeIcon()

Get the large-icon of the deployment descriptor.

Specified by:

getLargeIcon in interface IDescriptionGroupDesc

Returns:

the large-icon of the deployment descriptor.

toString

public abstract String toString()

Return a String representation of the DeploymentDesc.

Specified by:

toString in interface IDescriptionGroupDesc

Overrides:

toString in class Object

Returns:

a String representation of the DeploymentDesc.

getSAXMsg

protected static String getSAXMsg(String fileName,
                                  SAXParseException exception,
                                  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