Package io.toro.martini

Class PackageMethods

java.lang.Object

io.toro.martini.PackageMethods

public final class PackageMethods
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PackageMethods.MartiniPackageSetter	An internal class used for setting the MartiniPackage of the ThreadLocal
(package private) static class	PackageMethods.PackageInheritableThreadLocal

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static ThreadLocal<EnhancedStack<MartiniPackage>>	context
(package private) static io.toro.martini.ipackage.PackageInfoService	packageInfoService

Constructor Summary

Constructors

Constructor	Description
PackageMethods(io.toro.martini.ipackage.PackageInfoService infoService)

Method Summary

Modifier and Type	Method	Description
static MartiniPackage	getPackage()	Get the package assigned to the current context.
static io.toro.martini.ipackage.PackageInfo	getPackageByName(String packageName)	Get PackageInfo based on packageName
static String	getPackageProperty(String key)	Get the value of a package property.
static String	getPackageProperty(String key, String defaultValue)	Get the value of a package property.
static String	getPackageProperty(String packageName, String key, String defaultValue)	Get the value of a package property
static String[]	getPackagePropertyArray(String key)	Get the value of a package property as an array.
static String[]	getPackagePropertyArray(String key, String[] defaultValue)	Get the value of a package property as an array.
static String[]	getPackagePropertyArray(String packageName, String key, String[] defaultValue)	Get the value of a package property as an array
static String	getPackagePropertyComment(String key)	Get the comment of a package property, useful for understanding the property's purpose.
static String	getPackagePropertyComment(String packageName, String key)	Get the comment of a package property in the package specified
static String	removePackageProperty(String key)	Delete a package property.
static String	removePackageProperty(String packageName, String key)	Delete a package property
static String	savePackageProperty(String key, String value)	Save a package property.
static String	savePackageProperty(String packageName, String key, String value)	Save a property in the package specified
static void	savePackagePropertyComment(String key, String comment)	Add a comment to a package property, useful for providing a description of the property.
static void	savePackagePropertyComment(String packageName, String key, String comment)	Add a comment to a package property in the package specified

Methods inherited from class java.lang.Object

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

Field Detail

context

static ThreadLocal<EnhancedStack<MartiniPackage>> context

packageInfoService

static io.toro.martini.ipackage.PackageInfoService packageInfoService

Constructor Detail

PackageMethods

PackageMethods(io.toro.martini.ipackage.PackageInfoService infoService)

Method Detail

getPackage

public static MartiniPackage getPackage()

Get the package assigned to the current context.

Returns:

the current context's package

getPackageByName

public static io.toro.martini.ipackage.PackageInfo getPackageByName(String packageName)

Get PackageInfo based on packageName

Parameters:

packageName -

Returns:

PackageInfo

savePackageProperty

public static String savePackageProperty(String key,
                                         String value)

Save a package property.

Package properties are local only to a package. This one-liner saves the property to the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.saveTOROProperty('value')
 

Parameters:

key - the property key

value - the property value

Returns:

the property's assigned value

Throws:

IllegalStateException - if package has not been set

Since:

1.0

savePackageProperty

public static String savePackageProperty(String packageName,
                                         String key,
                                         String value)

Save a property in the package specified

Parameters:

packageName - the name of package

key - the property key

value - the property value

Returns:

the property's assigned value

savePackagePropertyComment

public static void savePackagePropertyComment(String key,
                                              String comment)

Add a comment to a package property, useful for providing a description of the property.

Package properties are local only to a package. This one-liner saves the property comment to the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.savePackagePropertyComment('This is a comment describing a property.')
 

Parameters:

key - the property key

comment - the comment to the key

Throws:

IllegalStateException - if package has not been set

Since:

1.0

savePackagePropertyComment

public static void savePackagePropertyComment(String packageName,
                                              String key,
                                              String comment)

Add a comment to a package property in the package specified

Parameters:

packageName - the name of package

key - the property key

comment - the comment to the key

comment -

getPackagePropertyComment

public static String getPackagePropertyComment(String key)

Get the comment of a package property, useful for understanding the property's purpose.

Package properties are local only to a package. This one-liner fetches the property comment from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.getPackagePropertyComment()
 

Parameters:

key - the property key

Returns:

package property comment

Throws:

IllegalStateException - if package has not been set

Since:

1.0

getPackagePropertyComment

public static String getPackagePropertyComment(String packageName,
                                               String key)

Get the comment of a package property in the package specified

Parameters:

packageName - the name of package

key - the property key

Returns:

getPackagePropertyArray

public static String[] getPackagePropertyArray(String key,
                                               String[] defaultValue)

Get the value of a package property as an array. Every comma-separated value in the property is assigned to one array element.

Package properties are local only to a package. This one-liner fetches the property from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.getPackagePropertyArray(['default', 'values'])
 

Parameters:

key - the property key

defaultValue - the value to return if the property doesn't exist

Returns:

the property value, or defaultValue if the property doesn't exist

Throws:

IllegalStateException - if package has not been set

Since:

1.0

getPackagePropertyArray

public static String[] getPackagePropertyArray(String packageName,
                                               String key,
                                               String[] defaultValue)

Get the value of a package property as an array

Parameters:

packageName - the name of package

key - the property key

defaultValue -

Returns:

getPackagePropertyArray

public static String[] getPackagePropertyArray(String key)

Get the value of a package property as an array. Every comma-separated value in the property is assigned to one array element.

Package properties are local only to a package. This one-liner fetches the property from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.getPackagePropertyArray()
 

Parameters:

key - the property key

Returns:

the property value, or null if the property doesn't exist

Throws:

IllegalStateException - if package has not been set

Since:

1.0

getPackageProperty

public static String getPackageProperty(String key)

Get the value of a package property.

Package properties are local only to a package. This one-liner fetches the property from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.getPackageProperty()
 

Parameters:

key - the property key

Returns:

the property value, or null if the property doesn't exist

Throws:

IllegalStateException - if package has not been set

Since:

1.0

getPackageProperty

public static String getPackageProperty(String key,
                                        String defaultValue)

Get the value of a package property.

Package properties are local only to a package. This one-liner fetches the property from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.getPackageProperty('defaultValue')
 

Parameters:

key - the property key

defaultValue - the value to return if the property doesn't exist

Returns:

the property value, or defaultValue if the property doesn't exist

Throws:

IllegalStateException - if package has not been set

Since:

1.0

getPackageProperty

public static String getPackageProperty(String packageName,
                                        String key,
                                        String defaultValue)

Get the value of a package property

Parameters:

packageName - the name of package

key - the property key

defaultValue -

Returns:

removePackageProperty

public static String removePackageProperty(String key)

Delete a package property.

Package properties are local only to a package. This one-liner removes the property from the package in the current context; specifically in the package's package.properties file.

Example usage:

 'key'.removePackageProperty()
 

Parameters:

key - the property key

Returns:

the property's assigned value

Throws:

IllegalStateException - if package has not been set

Since:

1.0

removePackageProperty

public static String removePackageProperty(String packageName,
                                           String key)

Delete a package property

Parameters:

packageName - the name of package

key - the property key

Returns: