Enum Class BndProperties

java.lang.Object

java.lang.Enum<BndProperties>

org.jdrupes.builder.bnd.BndProperties

All Implemented Interfaces:

Serializable, Comparable<BndProperties>, Constable, PropertyKey

public enum BndProperties
extends Enum<BndProperties>
implements PropertyKey

This enum defines bnd specific property keys.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BndInstructions	Supports the definition of Bnd instructions as project properties.

Method Summary

Modifier and Type	Method	Description
<T> T	defaultValue()	The property's default value.
Class<?>	propertyType()	An explicitly set property type.
static BndProperties	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BndProperties[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface PropertyKey

name, type

Enum Constant Details

BndInstructions

public static final BndProperties BndInstructions

Supports the definition of Bnd instructions as project properties. Typically, this property is set for the root project to define default values.

Note that the BndAnalyzer does not pick up these instructions automatically. Rather, they have to be added explicitly with BndAnalyzer.instructions(Map).

Method Details

values

public static BndProperties[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BndProperties valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

propertyType

public Class<?> propertyType()

Description copied from interface: PropertyKey

An explicitly set property type. Only required if the default value is null or the type of the default value is a derived class of the desired property type.

Specified by:

propertyType in interface PropertyKey

Returns:

the class

defaultValue

public <T> T defaultValue()

Description copied from interface: PropertyKey

The property's default value. This value should either not be null or PropertyKey.propertyType() should return a non-null class.

Specified by:

defaultValue in interface PropertyKey

Type Parameters:

T - the generic type

Returns:

the object