de.enough.polish.ant.info
Class InfoSetting

java.lang.Object
  de.enough.polish.ant.info.InfoSetting

public class InfoSetting
extends Object

Represents the info-section of a polish project.

Copyright Enough Software 2004 - 2011

 history
        23-Jan-2003 - rob creation
 

Author:

Robert Virkus, robert@enough.de

Field Summary

static String	CLDC1_0
static String	CLDC1_1
static String	MICRO_EDITION_CONFIGURATION
static String	MICRO_EDITION_PROFILE
static String	MIDLET_DATA_SIZE
static String	MIDLET_DELETE_CONFIRM
static String	MIDLET_DELETE_NOTIFY
static String	MIDLET_DESCRIPTION
static String	MIDLET_ICON
static String	MIDLET_INFO_URL
static String	MIDLET_INSTALL_NOTIFY
static String	MIDLET_JAR_SIZE
static String	MIDLET_JAR_URL
static String	MIDLET_NAME
static String	MIDLET_OPTIONAL_PERMISSIONS
static String	MIDLET_PERMISSIONS
static String	MIDLET_VENDOR
static String	MIDLET_VERSION
static String	MIDP1
static String	MIDP2
static String	NMIDLET

Constructor Summary

InfoSetting()
Creates a new InfoSetting

Method Summary

void	addConfiguredAuthors(Authors authorsList)
void	addConfiguredVendorInfo(VendorInfo info)
Author[]	getAuthors()
String	getConfiguration()
String	getCopyright()
String	getDataSize()
String	getDeleteConfirm()
String	getDeleteNotify()
String	getDescription()
String	getIcon()
String	getInfoUrl()
String	getInstallNotify()
Attribute[]	getJadAttributes(Environment env) Retrieves all attributes for the JAD file.
String	getJarName() Gets the name of the jar file.
String	getJarUrl() Retrieves the URL of the Jar-File.
Attribute[]	getManifestAttributes(Environment env) Retrieves all manifest attributes for the JAR file.
String	getName()
String	getProfile()
VendorInfo	getVendorInfo()
String	getVendorName()
String	getVersion()
void	setConfiguration(String configuration)
void	setCopyright(String copyright)
void	setDataSize(String dataSize)
void	setDefaultJarUrl() Sets the jarName as the default jarUrl but only when no jarUrl has been specified.
void	setDeleteConfirm(String deleteConfirm)
void	setDeleteNotify(String deleteNotify)
void	setDescription(String description)
void	setIcon(String icon)
void	setInfoUrl(String infoUrl)
void	setInstallNotify(String installNotify)
void	setJarName(String jarName) Sets the name of the jar file which will be created.
void	setJarUrl(String jarUrl) Sets the URL of the Jar-File.
void	setLicense(String license) Sets the license of the license key for this project.
void	setName(String name)
void	setOptionalPermissions(String optionalPermissions) Sets the optional permissions of this application.
void	setPermissions(String permissions) Sets the permissions of this application.
void	setProfile(String profile)
void	setVendorName(String vendorName)
void	setVersion(String version)

Methods inherited from class java.lang.Object

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

Field Detail

MIDLET_NAME

public static final String MIDLET_NAME

See Also:

Constant Field Values

MIDLET_VERSION

public static final String MIDLET_VERSION

See Also:

Constant Field Values

MIDLET_VENDOR

public static final String MIDLET_VENDOR

See Also:

Constant Field Values

MIDLET_JAR_URL

public static final String MIDLET_JAR_URL

See Also:

Constant Field Values

MIDLET_JAR_SIZE

public static final String MIDLET_JAR_SIZE

See Also:

Constant Field Values

MICRO_EDITION_PROFILE

public static final String MICRO_EDITION_PROFILE

See Also:

Constant Field Values

MICRO_EDITION_CONFIGURATION

public static final String MICRO_EDITION_CONFIGURATION

See Also:

Constant Field Values

MIDLET_ICON

public static final String MIDLET_ICON

See Also:

Constant Field Values

MIDLET_DESCRIPTION

public static final String MIDLET_DESCRIPTION

See Also:

Constant Field Values

MIDLET_INFO_URL

public static final String MIDLET_INFO_URL

See Also:

Constant Field Values

MIDLET_DATA_SIZE

public static final String MIDLET_DATA_SIZE

See Also:

Constant Field Values

MIDLET_DELETE_CONFIRM

public static final String MIDLET_DELETE_CONFIRM

See Also:

Constant Field Values

MIDLET_DELETE_NOTIFY

public static final String MIDLET_DELETE_NOTIFY

See Also:

Constant Field Values

MIDLET_INSTALL_NOTIFY

public static final String MIDLET_INSTALL_NOTIFY

See Also:

Constant Field Values

MIDLET_PERMISSIONS

public static final String MIDLET_PERMISSIONS

See Also:

Constant Field Values

MIDLET_OPTIONAL_PERMISSIONS

public static final String MIDLET_OPTIONAL_PERMISSIONS

See Also:

Constant Field Values

NMIDLET

public static final String NMIDLET

See Also:

Constant Field Values

CLDC1_0

public static final String CLDC1_0

See Also:

Constant Field Values

CLDC1_1

public static final String CLDC1_1

See Also:

Constant Field Values

MIDP1

public static final String MIDP1

See Also:

Constant Field Values

MIDP2

public static final String MIDP2

See Also:

Constant Field Values

Constructor Detail

InfoSetting

public InfoSetting()

Creates a new InfoSetting

Method Detail

getCopyright

public String getCopyright()

Returns:

Returns the copyright.

setCopyright

public void setCopyright(String copyright)

Parameters:

copyright - The copyright to set.

getDeleteConfirm

public String getDeleteConfirm()

Returns:

Returns the deleteConfirm.

setDeleteConfirm

public void setDeleteConfirm(String deleteConfirm)

Parameters:

deleteConfirm - The deleteConfirm to set.

getDeleteNotify

public String getDeleteNotify()

Returns:

Returns the deleteNotify.

setDeleteNotify

public void setDeleteNotify(String deleteNotify)

Parameters:

deleteNotify - The deleteNotify to set.

getDescription

public String getDescription()

Returns:

Returns the description.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

getIcon

public String getIcon()

Returns:

Returns the icon.

setIcon

public void setIcon(String icon)

Parameters:

icon - The icon to set.

getInfoUrl

public String getInfoUrl()

Returns:

Returns the infoUrl.

setInfoUrl

public void setInfoUrl(String infoUrl)

Parameters:

infoUrl - The infoUrl to set.

getInstallNotify

public String getInstallNotify()

Returns:

Returns the installNotify.

setInstallNotify

public void setInstallNotify(String installNotify)

Parameters:

installNotify - The installNotify to set.

getJarUrl

public String getJarUrl()

Retrieves the URL of the Jar-File. The URL can contain several properties. Following properties are allowed:

• polish.identifier: The vendor and name of the current device, e.g. "Nokia/3650". Note that the identifier contains a slash, which might result in undesired behaviour (since it might point to a different folder).
• polish.name: The name of the current device, e.g. "3650".
• polish.vendor: The name of the vendor of the current device, e.g. "Nokia".
• polish.version: The version of the project as defined in the attribute [version].
• polish.jarName: The name of the jar-file as defined in the attribute [jarName].

Returns:

Returns the URL of the jar-file.

setJarUrl

public void setJarUrl(String jarUrl)

Sets the URL of the Jar-File. The URL can contain several properties. Following properties are allowed:

• polish.identifier: The vendor and name of the current device, e.g. "Nokia/3650". Note that the identifier contains a slash, which might result in undesired behaviour (since it might point to a different folder).
• polish.name: The name of the current device, e.g. "3650".
• polish.vendor: The name of the vendor of the current device, e.g. "Nokia".
• polish.version: The version of the project as defined in the attribute [version].
• polish.jarName: The name of the jar-file as defined in the attribute [jarName].

Parameters:

jarUrl - The jarUrl to set.

getName

public String getName()

Returns:

Returns the name of this project.

setName

public void setName(String name)

Parameters:

name - The name of this project.

addConfiguredAuthors

public void addConfiguredAuthors(Authors authorsList)

getAuthors

public Author[] getAuthors()

addConfiguredVendorInfo

public void addConfiguredVendorInfo(VendorInfo info)

getVendorInfo

public VendorInfo getVendorInfo()

setVendorName

public void setVendorName(String vendorName)

getVendorName

public String getVendorName()

getDataSize

public String getDataSize()

Returns:

the size which this midlet needs for the storage of data

setDataSize

public void setDataSize(String dataSize)

Parameters:

dataSize - the size which this midlet needs for the storage of data

getManifestAttributes

public Attribute[] getManifestAttributes(Environment env)

Retrieves all manifest attributes for the JAR file.

Parameters:

env - the environment

Returns:

an Attribute array containing all defined attributes for the JAR-Manifest.

getJadAttributes

public Attribute[] getJadAttributes(Environment env)

Retrieves all attributes for the JAD file.

Parameters:

env - the environment

Returns:

an Attribute array containing all defined attributes for the JAD-file.

getVersion

public String getVersion()

Returns:

Returns the midlet-version.

setVersion

public void setVersion(String version)

Parameters:

version - The version to set.

getJarName

public String getJarName()

Gets the name of the jar file. The name can contain several properties. Following properties are allowed:

• polish.identifier: The vendor and name of the current device, e.g. "Nokia/3650". Note that the identifier contains a slash, which might result in undesired behaviour (since it might point to a different folder).
• polish.name: The name of the current device, e.g. "3650".
• polish.vendor: The name of the vendor of the current device, e.g. "Nokia".
• polish.version: The version of the project as defined in the attribute [version].
• :

Returns:

The name of this Jar-File.

setJarName

public void setJarName(String jarName)

Sets the name of the jar file which will be created. The name can contain several properties. Following properties are allowed:

• polish.identifier: The vendor and name of the current device, e.g. "Nokia/3650". Note that the identifier contains a slash, which might result in undesired behaviour (since it might point to a different folder).
• polish.name: The name of the current device, e.g. "3650".
• polish.vendor: The name of the vendor of the current device, e.g. "Nokia".
• polish.version: The version of the project as defined in the attribute [version].
• :

Parameters:

jarName - The name of the jar file.

setOptionalPermissions

public void setOptionalPermissions(String optionalPermissions)

Sets the optional permissions of this application.

Parameters:

optionalPermissions - The permissions which are useful for this application to work, e.g. "javax.microedition.io.Connector.http"

setPermissions

public void setPermissions(String permissions)

Sets the permissions of this application.

Parameters:

permissions - The permissions which are needed for this application to work, e.g. "javax.microedition.io.Connector.http"

setLicense

public void setLicense(String license)

Sets the license of the license key for this project.

Parameters:

license - The license of the created applications, either "GPL" or the license-key for commercial use.

setDefaultJarUrl

public void setDefaultJarUrl()

Sets the jarName as the default jarUrl but only when no jarUrl has been specified.

getConfiguration

public String getConfiguration()

setConfiguration

public void setConfiguration(String configuration)

getProfile

public String getProfile()

setProfile

public void setProfile(String profile)