Package io.jenkins.plugins.casc.impl.attributes

Class DescribableAttribute<Owner,Type>

java.lang.Object

io.jenkins.plugins.casc.Attribute<Owner,Type>

io.jenkins.plugins.casc.impl.attributes.DescribableAttribute<Owner,Type>

Direct Known Subclasses:

DescribableListAttribute

public class DescribableAttribute<Owner,Type>
extends Attribute<Owner,Type>

Author:

Nicolas De Loof

Nested Class Summary

Nested classes/interfaces inherited from class io.jenkins.plugins.casc.Attribute

Attribute.Getter<O,T>, Attribute.Setter<O,T>

Field Summary

Fields inherited from class io.jenkins.plugins.casc.Attribute

aliases, multiple, name, preferredName, type

Constructor Summary

Constructors

Constructor	Description
DescribableAttribute(String name, Class<? extends Describable> type)

Method Summary

Modifier and Type	Method	Description
static String	getPreferredSymbol(Descriptor d, Class extensionPoint, Class target)	Retrieve the preferred symbol for this descriptor
static List<String>	getSymbols(Descriptor d, Class extensionPoint, Class target)	Retrieve all possible symbols for this descriptor, first one being preferred one.
List<String>	possibleValues()	If this attribute is constrained to a limited set of value, here they are

Methods inherited from class io.jenkins.plugins.casc.Attribute

alias, calculateIfSecret, deprecated, describe, describeForSchema, equals, equals, get, getAliases, getGetter, getName, getRestrictions, getSetter, getter, getType, getValue, hashCode, isDeprecated, isMultiple, isRestricted, isSecret, multiple, noop, preferredName, restrictions, secret, setJsonSchema, setter, setValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribableAttribute

public DescribableAttribute(String name,
                            Class<? extends Describable> type)

Method Detail

possibleValues

public List<String> possibleValues()

Description copied from class: Attribute

If this attribute is constrained to a limited set of value, here they are

Overrides:

possibleValues in class Attribute<Owner,Type>

Returns:

A list of possible types

getPreferredSymbol

public static String getPreferredSymbol(Descriptor d,
                                        Class extensionPoint,
                                        Class target)

Retrieve the preferred symbol for this descriptor

getSymbols

public static List<String> getSymbols(Descriptor d,
                                      Class extensionPoint,
                                      Class target)

Retrieve all possible symbols for this descriptor, first one being preferred one. If a Symbol annotation is set, all values are accepted the last one being preferred