Top Fields Constructors Methods
com.sun.faces.context

public Class RequestParameterMap

extends BaseContextMap<String>
Class Inheritance
Imports
java.util.Collection, .Collections, .Iterator, .Map, .Set, com.sun.faces.util.Util, jakarta.faces.context.FacesContext, jakarta.servlet.ServletRequest
See Also
jakarta.faces.context.ExternalContext#getRequestParameterMap()

Field Summary

Modifier and TypeField and Description
private boolean
inspectedParameterNames

private String
namingContainerPrefix

private final ServletRequest
request

Constructor Summary

AccessConstructor and Description
public
RequestParameterMap(ServletRequest request)

Method Summary

Modifier and TypeMethod and Description
public boolean
containsKey(Object
key whose presence in this map is to be tested
key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.

public Set<Map.Entry<String, String>>
entrySet()

Overrides com.sun.faces.context.BaseContextMap.entrySet.

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.

public boolean
equals(Object
object to be compared for equality with this map
obj)

Overrides java.util.AbstractMap.equals.

Implements java.util.Map.equals.

Compares the specified object with this map for equality.

public String
get(Object
the key whose associated value is to be returned
key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

protected Iterator<Map.Entry<String, String>>
getEntryIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getEntryIterator.

protected Iterator<String>
getKeyIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getKeyIterator.

protected String

Returns:

The naming container prefix, or an empty string if the view root is not an instance of naming container.
getNamingContainerPrefix()

If view root is instance of naming container, return its container client id, suffixed with separator character.

protected Iterator<String>
getValueIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getValueIterator.

public int
hashCode()

Overrides java.util.AbstractMap.hashCode.

Implements java.util.Map.hashCode.

Returns the hash code value for this map.

public Set<String>
keySet()

Overrides com.sun.faces.context.BaseContextMap.keySet.

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.

public Collection<String>
values()

Overrides com.sun.faces.context.BaseContextMap.values.

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.

Inherited from com.sun.faces.context.BaseContextMap:
clearputAllremoveremoveKeyremoveValue

Field Detail

inspectedParameterNamesback to summary
private boolean inspectedParameterNames
namingContainerPrefixback to summary
private String namingContainerPrefix
requestback to summary
private final ServletRequest request

Constructor Detail

RequestParameterMapback to summary
public RequestParameterMap(ServletRequest request)

Method Detail

containsKeyback to summary
public boolean containsKey(Object key)

Overrides java.util.AbstractMap.containsKey.

Implements java.util.Map.containsKey.

Doc from java.util.AbstractMap.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters
key:Object

Doc from java.util.Map.containsKey.

key whose presence in this map is to be tested

Returns:boolean

Doc from java.util.Map.containsKey.

true if this map contains a mapping for the specified key

Annotations
@Override
entrySetback to summary
public Set<Map.Entry<String, String>> entrySet()

Overrides com.sun.faces.context.BaseContextMap.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<Map.Entry<String, String>>

a set view of the mappings contained in this map

Annotations
@Override
equalsback to summary
public boolean equals(Object obj)

Overrides java.util.AbstractMap.equals.

Implements java.util.Map.equals.

Doc from java.util.AbstractMap.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters
obj:Object

object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

Annotations
@Override
getback to summary
public String get(Object key)

Overrides java.util.AbstractMap.get.

Implements java.util.Map.get.

Doc from java.util.AbstractMap.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

Doc from java.util.Map.get.

the key whose associated value is to be returned

Returns:String

Doc from java.util.Map.get.

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations
@Override
getEntryIteratorback to summary
protected Iterator<Map.Entry<String, String>> getEntryIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getEntryIterator.

Annotations
@Override
getKeyIteratorback to summary
protected Iterator<String> getKeyIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getKeyIterator.

Annotations
@Override
getNamingContainerPrefixback to summary
protected String getNamingContainerPrefix()

If view root is instance of naming container, return its container client id, suffixed with separator character.

Returns:String

The naming container prefix, or an empty string if the view root is not an instance of naming container.

getValueIteratorback to summary
protected Iterator<String> getValueIterator()

Implements abstract com.sun.faces.context.BaseContextMap.getValueIterator.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.util.AbstractMap.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.AbstractMap.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

Annotations
@Override
keySetback to summary
public Set<String> keySet()

Overrides com.sun.faces.context.BaseContextMap.keySet.

Implements java.util.Map.keySet.

Doc from java.util.AbstractMap.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<String>

Doc from java.util.Map.keySet.

a set view of the keys contained in this map

Annotations
@Override
valuesback to summary
public Collection<String> values()

Overrides com.sun.faces.context.BaseContextMap.values.

Implements java.util.Map.values.

Doc from java.util.AbstractMap.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<String>

Doc from java.util.Map.values.

a collection view of the values contained in this map

Annotations
@Override