PropertyResolver (docs 1.3.3 API)

org.ysb33r.grolifant.api.v4.PropertyResolver

Resolves properties in a certain i.e. like SpringBoot, but less functionality to suite Gradle context.
Authors:
Schalk W. Cronjé
Since:
0.15.0

Field Summary

Fields
Modifiers	Name	Description
`static PropertyResolveOrder`	`PROJECT_SYSTEM_ENV`
`static PropertyResolveOrder`	`SYSTEM_ENV_PROPERTY`

Constructor Summary

Constructors
Constructor and description
`PropertyResolver (Project project)` Creates a property resolver that will use PROJECT_SYSTEM_ENV by default.
`PropertyResolver (Project project, PropertyResolveOrder order)` Creates a property resolver with a custom resolve order
`PropertyResolver (ProjectOperations projectOperations)` Creates a property resolver with a custom resolve order

Methods Summary

Methods
Type Params	Return Type	Name and description
	`String`	`get(String name)` Gets a property.
	`String`	`get(String name, String defaultValue)` Gets a property.
	`String`	`get(String name, PropertyResolveOrder order)` Gets a property using a specific resolve order.
	`String`	`get(String name, String defaultValue, PropertyResolveOrder order)` Gets a property using a specific resolve order
	`void`	`order(PropertyResolveOrder newOrder)` Change the existing property order
	`Provider<String>`	`provide(String name)` Gets a provider to a property.
	`Provider<String>`	`provide(String name, String defaultValue)` Gets a provider to a property.
	`Provider<String>`	`provide(String name, String defaultValue, PropertyResolveOrder order, boolean atConfigurationTime)` Gets a provider to a property using a specific resolve order.
	`Provider<String>`	`provideAtConfiguration(String name)` Gets a provider to a property that is safe to use at configuration-time.
	`Provider<String>`	`provideAtConfiguration(String name, String defaultValue)` Gets a provider to a property that is safe to use at configuration-time.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final PropertyResolveOrder PROJECT_SYSTEM_ENV
  - public static final PropertyResolveOrder SYSTEM_ENV_PROPERTY
- Constructor Detail
  - PropertyResolver(Project project)
    
    Creates a property resolver that will use PROJECT_SYSTEM_ENV by default.
    Parameters:
    project - Project context in which to resolve properties. The project will not be cached, but is used to obtain a reference to the project's properties.
  - PropertyResolver(Project project, PropertyResolveOrder order)
    
    Creates a property resolver with a custom resolve order
    Parameters:
    project - Project context in which to resolve properties.
    order - Custom property resolve order
  - PropertyResolver(ProjectOperations projectOperations)
    
    Creates a property resolver with a custom resolve order
    Parameters:
    projectOperations - Project context in which to resolve properties.
    order - Custom property resolve order
- Method Detail
  - String get(String name)
    
    Gets a property.
    Parameters:
    name - Name of property to resolve
    Returns:
    Resolved property or null if no property was found.
  - String get(String name, String defaultValue)
    
    Gets a property.
    Parameters:
    name - Name of property to resolve.
    defaultValue - Value to return if property cannot be resolved.
    Returns:
    Resolved property or defaultValue if no property was found.
  - String get(String name, PropertyResolveOrder order)
    
    Gets a property using a specific resolve order.
    Parameters:
    name - Name of property to resolve
    order - Resolve order
    Returns:
    Resolved property or null if no property was found.
  - String get(String name, String defaultValue, PropertyResolveOrder order)
    
    Gets a property using a specific resolve order
    Parameters:
    name - Name of property to resolve.
    defaultValue - Value to return if property cannot be resolved.
    order - Resolve order.
    Returns:
    Resolved property or defaultValue if no property was found.
  - void order(PropertyResolveOrder newOrder)
    
    Change the existing property order
    Parameters:
    newOrder - New property resolve order.
  - Provider<String> provide(String name)
    
    Gets a provider to a property.
    Parameters:
    name - Name of property to resolve.
    Returns:
    Provider to a property.
    Since:
    1.1
  - Provider<String> provide(String name, String defaultValue)
    
    Gets a provider to a property.
    Parameters:
    name - Name of property to resolve.
    defaultValue - Value to return if property cannot be resolved.
    Returns:
    Provider to a property.
    Since:
    1.1
  - Provider<String> provide(String name, String defaultValue, PropertyResolveOrder order, boolean atConfigurationTime)
    
    Gets a provider to a property using a specific resolve order.
    code:
    null).
    
    Parameters:
    name - Name of property to resolve.
    defaultValue - Value to resturn if property cannot be resolved. (Can be
    order - Resolve order.
    atConfigurationTime - Whether to make the provider safe for usage at configuration time.
    Returns:
    Provider to a property.
    Since:
    1.1
  - Provider<String> provideAtConfiguration(String name)
    
    Gets a provider to a property that is safe to use at configuration-time.
    Parameters:
    name - Name of property to resolve.
    Returns:
    Provider to a property.
    Since:
    1.1
  - Provider<String> provideAtConfiguration(String name, String defaultValue)
    
    Gets a provider to a property that is safe to use at configuration-time.
    Parameters:
    name - Name of property to resolve.
    defaultValue - Value to return if property cannot be resolved.
    Returns:
    Provider to a property.
    Since:
    1.1

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[Groovy] Class PropertyResolver

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final PropertyResolveOrder PROJECT_SYSTEM_ENV

public static final PropertyResolveOrder SYSTEM_ENV_PROPERTY

Constructor Detail

PropertyResolver(Project project)

PropertyResolver(Project project, PropertyResolveOrder order)

PropertyResolver(ProjectOperations projectOperations)

Method Detail

String get(String name)

String get(String name, String defaultValue)

String get(String name, PropertyResolveOrder order)

String get(String name, String defaultValue, PropertyResolveOrder order)

void order(PropertyResolveOrder newOrder)

Provider<String> provide(String name)

Provider<String> provide(String name, String defaultValue)

Provider<String> provide(String name, String defaultValue, PropertyResolveOrder order, boolean atConfigurationTime)

Provider<String> provideAtConfiguration(String name)

Provider<String> provideAtConfiguration(String name, String defaultValue)