Interface OptionDescriptors

All Superinterfaces:

Iterable<OptionDescriptor>

public interface OptionDescriptors
extends Iterable<OptionDescriptor>

An interface to a set of OptionDescriptors.

Since:

19.0

Field Summary

Fields

Modifier and Type	Field	Description
static final OptionDescriptors	EMPTY	An empty set of option descriptors.

Method Summary

Modifier and Type	Method	Description
static OptionDescriptors	create(List<OptionDescriptor> descriptors)	Creates an OptionDescriptors instance from a list.
static OptionDescriptors	createUnion(OptionDescriptors... descriptors)	Creates a union options descriptor out of multiple given descriptors.
OptionDescriptor	get(String optionName)	Gets the OptionDescriptor matching a given option name or null if this option descriptor set does not contain a matching option name.
Iterator<OptionDescriptor>	iterator()

Methods inherited from interface Iterable

forEach, spliterator

Field Details

EMPTY

static final OptionDescriptors EMPTY

An empty set of option descriptors.

Since:

19.0

Method Details

get

OptionDescriptor get(String optionName)

Gets the OptionDescriptor matching a given option name or null if this option descriptor set does not contain a matching option name.

Since:

19.0

createUnion

static OptionDescriptors createUnion(OptionDescriptors... descriptors)

Creates a union options descriptor out of multiple given descriptors. The operation descriptors are not checked for duplicate keys. The option descriptors are iterated in declaration order.

Since:

19.0

iterator

Iterator<OptionDescriptor> iterator()

Specified by:

iterator in interface Iterable<OptionDescriptor>

Since:

19.0

create

static OptionDescriptors create(List<OptionDescriptor> descriptors)

Creates an OptionDescriptors instance from a list. The option descriptors implementation is backed by a LinkedHashMap that preserves ordering.

Since:

19.0