org.codehaus.mojo.webstart

Class JarResource

java.lang.Object

org.codehaus.mojo.webstart.JarResource

public class JarResource
extends Object

This class represents a <jarResource> configuration element from the pom.xml file. It identifies an artifact that is to be processed by the plugin for inclusion in the JNLP bundle.

Since:

19 May 2007

Version:

$Revision$

Author:

Kevin Stembridge, $LastChangedBy$

Constructor Summary

Constructors

Constructor and Description
JarResource()

Method Summary

Methods

Modifier and Type	Method and Description
String	getArtifactId() Returns the value of the artifactId field.
String	getClassifier() Returns the value of the classifier field.
String	getGroupId() Returns the value of the groupId field.
String	getHrefValue() Returns the value that should be output for this jar in the href attribute of the jar resource element in the generated JNLP file.
String	getMainClass() Returns the fully qualified class name of the JNLP application's 'main' class but only if it is contained in the jar represented by this instance.
String	getType() Returns the value of the type field.
String	getVersion() Returns the value of the version field.
boolean	isIncludeInJnlp() Returns the flag that indicates whether or not this resource should be included in the generated JNLP file.
boolean	isMandatoryField()
boolean	isOutputJarVersion() Returns the flag that indicates whether or not the jar resource element in the generated JNLP file should include a version attribute.
protected void	setOutputJarVersion(boolean outputJarVersion) Sets the flag that indicates whether or not the jar resource element in the generated JNLP file should include a version attribute.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JarResource

public JarResource()

Method Detail

getArtifactId

public String getArtifactId()

Returns the value of the artifactId field.

Returns:

Returns the value of the artifactId field.

getType

public String getType()

Returns the value of the type field.

Returns:

Returns the value of the type field.

getClassifier

public String getClassifier()

Returns the value of the classifier field.

Returns:

Returns the value of the classifier field.

getGroupId

public String getGroupId()

Returns the value of the groupId field.

Returns:

Returns the value of the groupId field.

getVersion

public String getVersion()

Returns the value of the version field.

Returns:

Returns the value of the version field.

getMainClass

public String getMainClass()

Returns the fully qualified class name of the JNLP application's 'main' class but only if it is contained in the jar represented by this instance. Only one jarResource per plugin configuration can be declared with a main class. This is the value that will be populated in the generated JNLP file.

Returns:

Returns the value of the mainClass field, or null if the jar represented by this instance is not the one that contains the application's main class.

isMandatoryField

public boolean isMandatoryField()

setOutputJarVersion

protected void setOutputJarVersion(boolean outputJarVersion)

Sets the flag that indicates whether or not the jar resource element in the generated JNLP file should include a version attribute. Default is true.

Parameters:

outputJarVersion - new value of field outputJarVersion

isOutputJarVersion

public boolean isOutputJarVersion()

Returns the flag that indicates whether or not the jar resource element in the generated JNLP file should include a version attribute. Default is true.

Returns:

Returns the value of the outputJarVersion field.

isIncludeInJnlp

public boolean isIncludeInJnlp()

Returns the flag that indicates whether or not this resource should be included in the generated JNLP file. The default is true, but you may want to exclude jars from the JNLP in cases where multiple versions of a jar are included in the JNLP bundle.

Returns:

Returns the value of the includeInJnlp field.

getHrefValue

public String getHrefValue()

Returns the value that should be output for this jar in the href attribute of the jar resource element in the generated JNLP file. If not set explicitly, this defaults to the file name of the underlying artifact.

Returns:

The href attribute to be output for this jar resource in the generated JNLP file definied by user.

toString

public String toString()

Overrides:

toString in class Object