com.botronsoft.cmj.spitools.dsl

Interface ArgumentDescriptor<T extends ArgumentDescriptor<?>>

Type Parameters:

T - the actual extending interface of this base interface.

All Known Subinterfaces:

MultiValueArgumentDescriptor, SingleValueArgumentDescriptor

All Known Implementing Classes:

AbstractArgumentDescriptor, MultiValueArgumentDescriptorImpl, SingleValueArgumentDescriptorImpl

@PublicApi
public interface ArgumentDescriptor<T extends ArgumentDescriptor<?>>

Base interface for all argument descriptors. Holds the common methods for describing argument syntax - how references to configuration elements are stored in the arguments. Instances of this interface may be created by invoking the methods of ArgumentContainerDescriptor.

Method Summary

Modifier and Type	Method and Description
ArgumentContainerDescriptor	and() Describes addition of a new argument descriptor for the parent ArgumentContainerDescriptor.
T	byId() Describes if the configuration element is referenced by id in this argument.
T	byKey() Describes if the configuration element is referenced by key in this argument.
T	byName() Describes if the configuration element is referenced by name in this argument.
T	ofType(ArgumentType argumentType) Describes the type of a referenced configuration element in this argument.
T	withLiteralValues(String... literalValues) Describes the literal values of this argument that should be moved as-is.
T	withPrefix(String prefix) Describes that the configuration element is referenced by value with prefix.

Method Detail

ofType

T ofType(ArgumentType argumentType)

Describes the type of a referenced configuration element in this argument.

Parameters:

argumentType - type of a referenced configuration element in this argument.

Returns:

itself.

byId

T byId()

Describes if the configuration element is referenced by id in this argument. For ArgumentType.USER this method will behave in the same way as byKey().

Returns:

itself.

byName

T byName()

Describes if the configuration element is referenced by name in this argument.

Returns:

itself.

byKey

T byKey()

Describes if the configuration element is referenced by key in this argument. This is supported only for elements which have keys - ArgumentType.PROJECT and ArgumentType.USER. For all other configuration elements this method will behave in the same way as byId().

Returns:

itself.

withPrefix

T withPrefix(String prefix)

Describes that the configuration element is referenced by value with prefix.

Parameters:

prefix - the prefix of the value

Returns:

itself.

withLiteralValues

T withLiteralValues(String... literalValues)

Describes the literal values of this argument that should be moved as-is. If the argument holds any of the values passed to this method, it will be exported and imported without any modifications.

Parameters:

literalValues - literal values of this argument.

Returns:

itself.

and

ArgumentContainerDescriptor and()

Describes addition of a new argument descriptor for the parent ArgumentContainerDescriptor.

Returns:

the parent ArgumentContainerDescriptor instance.