com.sidneysimmons.gradlepluginexternalproperties

Class ExternalPropertiesContainer

java.lang.Object

com.sidneysimmons.gradlepluginexternalproperties.ExternalPropertiesContainer

public class ExternalPropertiesContainer
extends java.lang.Object

Container that allows the user access to the properties.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
ExternalPropertiesContainer(org.gradle.api.Project project, ExternalPropertiesExtension extension) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	exists(java.lang.String propertyName) Determine if a property value exists for the given property name.
java.lang.String	get(java.lang.String propertyName) Get the property value for the given property name.
java.lang.String	get(java.lang.String propertyName, java.lang.String defaultValue) Get the property value for the given property name.
java.util.List<PropertyResolver>	getDefaultResolvers() Get all the default property resolvers.
java.util.List<PropertyResolver>	getResolvers() Get all the property resolvers for this project.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ExternalPropertiesContainer

public ExternalPropertiesContainer(org.gradle.api.Project project,
                                   ExternalPropertiesExtension extension)

Constructor.

Parameters:

project - the project

extension - the extension

Method Detail

get

public java.lang.String get(java.lang.String propertyName)

Get the property value for the given property name. Throws a runtime exception if the property isn't found.

Parameters:

propertyName - the property name

Returns:

the property value

get

public java.lang.String get(java.lang.String propertyName,
                            java.lang.String defaultValue)

Get the property value for the given property name. Returns the given default value if the property isn't found.

Parameters:

propertyName - the property name

defaultValue - the default value

Returns:

the property value

exists

public java.lang.Boolean exists(java.lang.String propertyName)

Determine if a property value exists for the given property name.

Parameters:

propertyName - the property name

Returns:

true if the property exists, false otherwise

getResolvers

public java.util.List<PropertyResolver> getResolvers()

Get all the property resolvers for this project. Does not include parent projects. Uses defaults if the user doesn't specify any custom resolvers.

Returns:

the list of property resolvers

getDefaultResolvers

public java.util.List<PropertyResolver> getDefaultResolvers()

Get all the default property resolvers. The following files are defined as defaults:

1. [USER HOME]/.overrides/[PROJECT NAME]/build.properties
2. [PROJECT ROOT]/build.properties

Returns:

the list of property resolvers