Class AttributesImpl
java.lang.Object
org.glassfish.security.services.impl.common.AttributesImpl
- All Implemented Interfaces:
Attributes
- Direct Known Subclasses:
AzAttributesImpl
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAttribute(String name, String[] values, boolean replace) Add the specified attribute to the attributes collection.voidaddAttribute(String name, String value, boolean replace) Add the specified attribute to the attributes collection.voidaddAttribute(String name, Set<String> values, boolean replace) Add the specified attribute to the attributes collection.voidclear()Removes all attributes from the collection.getAttribute(String name) Get the Attribute object for the named attribute, if present.intGet a count of the number of Attributes (not attribute values) in this Attributes object.Get the attribute names, as a Set.getAttributeValue(String name) Get the value of the specified attribute, if present.getAttributeValues(String name) Get the Set of values for the specified attribute, if present.String[]Get the set of values for the specified attribute as a String array.voidRemove all values associated with the named attribute, but do not remove the attribute from the collection.voidremoveAttribute(String name) Remove the specified attribute from the collection.voidremoveAttributeValue(String name, String value) Remove the specified value from the named attribute.voidremoveAttributeValues(String name, String[] values) Remove the specified values from the named attribute.voidremoveAttributeValues(String name, Set<String> values) Remove the specified values from the named attribute.
-
Constructor Details
-
AttributesImpl
public AttributesImpl() -
AttributesImpl
Copy constructor
-
-
Method Details
-
getAttributeCount
public int getAttributeCount()Description copied from interface:AttributesGet a count of the number of Attributes (not attribute values) in this Attributes object.- Specified by:
getAttributeCountin interfaceAttributes- Returns:
- The attribute count.
-
getAttributeNames
Description copied from interface:AttributesGet the attribute names, as a Set. This set is read-only; updating it will not change the underlying attributes collection.- Specified by:
getAttributeNamesin interfaceAttributes- Returns:
- The attribute names Set.
-
getAttribute
Description copied from interface:AttributesGet the Attribute object for the named attribute, if present.- Specified by:
getAttributein interfaceAttributes- Parameters:
name- The name of the Attribute to get.- Returns:
- The Attribute, or null if an attribute by that name is not present.
-
getAttributeValue
Description copied from interface:AttributesGet the value of the specified attribute, if present. Note that, for multi-valued attributes, The value returned is whichever value is returned first by the underlying Set implementation; there are no ordering guarantees. As such, this method is primarily useful as a shorthand method for attributes known (or expected) by the caller to be single-valued. Note also that it is not possible, using this method, to distinguish between a missing attribute and an attribute that is present but has no values. In both cases, null is returned.- Specified by:
getAttributeValuein interfaceAttributes- Parameters:
name- The name of the attribute whose value is wanted.- Returns:
- The attribute value, or null if the attribute is missing or has no values.
-
getAttributeValues
Description copied from interface:AttributesGet the Set of values for the specified attribute, if present.- Specified by:
getAttributeValuesin interfaceAttributes- Parameters:
name- The name of the attribute whose values are wanted.- Returns:
- The Set of values, or null if the attribute is not present in the collection. If the attribute is present but has no values, an empty Set is returned.
-
getAttributeValuesAsArray
Description copied from interface:AttributesGet the set of values for the specified attribute as a String array.- Specified by:
getAttributeValuesAsArrayin interfaceAttributes- Parameters:
name- The name of the attribute whose values are wanted.- Returns:
- The array of values, or null if the attribute is not present in the collection. If the attribute is present but has no values, a zero-length array is returned.
-
addAttribute
Description copied from interface:AttributesAdd the specified attribute to the attributes collection. Remove any existing values if the replace parameter is true, otherwise add the new value to the existing values. Duplicate values are silently dropped.- Specified by:
addAttributein interfaceAttributes- Parameters:
name- The name of the attribute to add.value- The single attribute value to add.replace- If true, replace the existing attribute and any existing values. If false, add the new value to those that are already present.
-
addAttribute
Description copied from interface:AttributesAdd the specified attribute to the attributes collection. Remove any existing values if the replace parameter is true, otherwise add the new values to the existing values. Duplicate values are silently dropped.- Specified by:
addAttributein interfaceAttributes- Parameters:
name- The name of the attribute to add.replace- If true, replace the existing attribute and any existing values. If false, add the new values to those that are already present.
-
addAttribute
Description copied from interface:AttributesAdd the specified attribute to the attributes collection. Remove any existing values if the replace parameter is true, otherwise add the new values to the existing values. Duplicate values are silently dropped.- Specified by:
addAttributein interfaceAttributes- Parameters:
name- The name of the attribute to add.replace- If true, replace the existing attribute and any existing values. If false, add the new values to those that are already present.
-
removeAttribute
Description copied from interface:AttributesRemove the specified attribute from the collection.- Specified by:
removeAttributein interfaceAttributes- Parameters:
name- The name of the attribute to remove.
-
removeAttributeValue
Description copied from interface:AttributesRemove the specified value from the named attribute.- Specified by:
removeAttributeValuein interfaceAttributes- Parameters:
name- The name of the attribute from which to remove a value.value- The value to remove. A value will be removed only if it exactly matches this parameter.
-
removeAttributeValues
Description copied from interface:AttributesRemove the specified values from the named attribute.- Specified by:
removeAttributeValuesin interfaceAttributes- Parameters:
name- The name of the attribute from which to remove the values.
-
removeAttributeValues
Description copied from interface:AttributesRemove the specified values from the named attribute.- Specified by:
removeAttributeValuesin interfaceAttributes- Parameters:
name- The name of the attribute from which to remove the values.
-
removeAllAttributeValues
Description copied from interface:AttributesRemove all values associated with the named attribute, but do not remove the attribute from the collection.- Specified by:
removeAllAttributeValuesin interfaceAttributes- Parameters:
name- The name of the attribute whose values should be removed.
-
clear
public void clear()Description copied from interface:AttributesRemoves all attributes from the collection.- Specified by:
clearin interfaceAttributes
-