com.cloudbees.plugins.credentials.common

Class AbstractIdCredentialsListBoxModel<T extends AbstractIdCredentialsListBoxModel<T,C>,C extends IdCredentials>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<hudson.util.ListBoxModel.Option>

hudson.util.ListBoxModel

com.cloudbees.plugins.credentials.common.AbstractIdCredentialsListBoxModel<T,C>

All Implemented Interfaces:

Serializable, Cloneable, Iterable<hudson.util.ListBoxModel.Option>, Collection<hudson.util.ListBoxModel.Option>, List<hudson.util.ListBoxModel.Option>, RandomAccess, org.kohsuke.stapler.HttpResponse

Direct Known Subclasses:

StandardListBoxModel, StandardUsernameListBoxModel

public abstract class AbstractIdCredentialsListBoxModel<T extends AbstractIdCredentialsListBoxModel<T,C>,C extends IdCredentials>
extends hudson.util.ListBoxModel

Base class for ListBoxModel types that present a selection of credentials where the selection is keyed by the credential's IdCredentials.getId().

Since:

1.6

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.util.ListBoxModel

hudson.util.ListBoxModel.Option

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
AbstractIdCredentialsListBoxModel()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	describe(C c) Generate a description of the supplied credential.
AbstractIdCredentialsListBoxModel<T,C>	with(C u) Adds a single credential.
AbstractIdCredentialsListBoxModel<T,C>	withAll(C... credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withAll(Iterable<? extends C> credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withAll(Iterator<? extends C> credentials) Adds supplied credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withEmptySelection() Adds an "empty" credential to signify selection of no credential.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, C... credentials) Adds the matching subset of suppled credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, Iterable<? extends C> credentials) Adds the matching subset of suppled credentials to the model.
AbstractIdCredentialsListBoxModel<T,C>	withMatching(CredentialsMatcher matcher, Iterator<? extends C> credentials) Adds the matching subset of suppled credentials to the model.

Methods inherited from class hudson.util.ListBoxModel

add, add, add, generateResponse, values, writeTo

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeRange, retainAll, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Constructor Detail

AbstractIdCredentialsListBoxModel

public AbstractIdCredentialsListBoxModel()

Method Detail

describe

@NonNull
protected abstract String describe(@NonNull
                      C c)

Generate a description of the supplied credential.

Parameters:

c - the credential.

Returns:

the description.

with

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> with(@CheckForNull
                                                  C u)

Adds a single credential.

Parameters:

u - the credential to add.

Returns:

this for method chaining.

withEmptySelection

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withEmptySelection()

Adds an "empty" credential to signify selection of no credential.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     C... credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     Iterable<? extends C> credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withAll

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withAll(@NonNull
                                                     Iterator<? extends C> credentials)

Adds supplied credentials to the model.

Parameters:

credentials - the credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          C... credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          Iterable<? extends C> credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.

withMatching

@NonNull
public AbstractIdCredentialsListBoxModel<T,C> withMatching(@NonNull
                                                          CredentialsMatcher matcher,
                                                          @NonNull
                                                          Iterator<? extends C> credentials)

Adds the matching subset of suppled credentials to the model.

Parameters:

matcher - the matcher.

credentials - the superset of credentials.

Returns:

this for method chaining.