org.apache.gora.compiler.utils

Class LicenseHeaders

java.lang.Object

org.apache.gora.compiler.utils.LicenseHeaders

public class LicenseHeaders
extends Object

Utility class which specifies a collection of license headers which can be used within the GoraCompiler for generating alternative license headers for Java interfaces and classes generated from protocols and schemas.

Constructor Summary

Constructors

Constructor and Description
LicenseHeaders(String pLicenseName)

Method Summary

Modifier and Type	Method and Description
String	getLicense() Get the license header for the LicenseHeader object.
String	getLicenseName() Get the license name for the LicenseHeader object.
void	initializeRelations() Initializes relations between supported licenses and license text
boolean	isValidLicense(String licenseName) Validate a given license name against the supported license
void	setLicenseName(String pLicenseName) Set the license header for the LicenseHeader object.

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseHeaders

public LicenseHeaders(String pLicenseName)

Parameters:

pLicenseName - the license header you wish to create with this object

Method Detail

initializeRelations

public void initializeRelations()

Initializes relations between supported licenses and license text

setLicenseName

public void setLicenseName(String pLicenseName)

Set the license header for the LicenseHeader object.

Parameters:

pLicenseName - the license name to set the header to

getLicense

public String getLicense()

Get the license header for the LicenseHeader object.

Returns:

get the license name (performing some checking to prevent NPE, etc.) you are advised to use this option

getLicenseName

public String getLicenseName()

Get the license name for the LicenseHeader object.

Returns:

get the license name

isValidLicense

public boolean isValidLicense(String licenseName)

Validate a given license name against the supported license

Parameters:

licenseName - name of the license

Returns:

a booolean whether the license is supported or not