Package com.cloudbees.plugins.credentials.matchers

Class ScopeMatcher

java.lang.Object

com.cloudbees.plugins.credentials.matchers.ScopeMatcher

All Implemented Interfaces:

CredentialsMatcher, CredentialsMatcher.CQL, Serializable

public class ScopeMatcher
extends Object
implements CredentialsMatcher, CredentialsMatcher.CQL

Matches credentials that are IdCredentials and have the specified CredentialsScope(s).

Since:

1.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.cloudbees.plugins.credentials.CredentialsMatcher

CredentialsMatcher.CQL

Constructor Summary

Constructors

Constructor	Description
ScopeMatcher(CredentialsScope scope)	Constructs a new instance.
ScopeMatcher(CredentialsScope... scopes)	Constructs a new instance.
ScopeMatcher(Collection<CredentialsScope> scopes)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
String	describe()	Describes this matcher in terms of a java-bean style query language
boolean	equals(Object o)
int	hashCode()
boolean	matches(Credentials item)	Evaluates the matcher for the specified credentials.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ScopeMatcher

public ScopeMatcher(@NonNull
 CredentialsScope scope)

Constructs a new instance.

Parameters:

scope - the scope to match.

ScopeMatcher

public ScopeMatcher(@NonNull
 CredentialsScope... scopes)

Constructs a new instance.

Parameters:

scopes - the scopes to match.

ScopeMatcher

public ScopeMatcher(@NonNull
 Collection<CredentialsScope> scopes)

Constructs a new instance.

Parameters:

scopes - the scopes to match.

Method Details

matches

public boolean matches(@NonNull
 Credentials item)

Evaluates the matcher for the specified credentials.

Specified by:

matches in interface CredentialsMatcher

Parameters:

item - the specified credentials.

Returns:

true if and only if the specified credentials match.

describe

public String describe()

Describes this matcher in terms of a java-bean style query language

Specified by:

describe in interface CredentialsMatcher.CQL

Returns:

the description of the credentials matcher query or null if the matcher cannot be expressed in CQL.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object