Class Filter
- All Implemented Interfaces:
Serializable
,Cloneable
A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getName()
The name of the filter.One or more filter values.int
hashCode()
void
The name of the filter.void
setValues
(Collection<String> values) One or more filter values.toString()
Returns a string representation of this object; useful for testing and debugging.The name of the filter.withValues
(String... values) One or more filter values.withValues
(Collection<String> values) One or more filter values.
-
Constructor Details
-
Filter
public Filter()Default constructor for Filter object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
Filter
Constructs a new Filter object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name
- The name of the filter. Filter names are case-sensitive.
-
Filter
Constructs a new Filter object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
name
- The name of the filter. Filter names are case-sensitive.values
- One or more filter values. Filter values are case-sensitive.
-
-
Method Details
-
setName
The name of the filter. Filter names are case-sensitive.
- Parameters:
name
- The name of the filter. Filter names are case-sensitive.
-
getName
The name of the filter. Filter names are case-sensitive.
- Returns:
- The name of the filter. Filter names are case-sensitive.
-
withName
The name of the filter. Filter names are case-sensitive.
- Parameters:
name
- The name of the filter. Filter names are case-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getValues
One or more filter values. Filter values are case-sensitive.
- Returns:
- One or more filter values. Filter values are case-sensitive.
-
setValues
One or more filter values. Filter values are case-sensitive.
- Parameters:
values
- One or more filter values. Filter values are case-sensitive.
-
withValues
One or more filter values. Filter values are case-sensitive.
NOTE: This method appends the values to the existing list (if any). Use
setValues(java.util.Collection)
orwithValues(java.util.Collection)
if you want to override the existing values.- Parameters:
values
- One or more filter values. Filter values are case-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withValues
One or more filter values. Filter values are case-sensitive.
- Parameters:
values
- One or more filter values. Filter values are case-sensitive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-