Package org.refcodes.net
Interface HttpFields<B extends HttpFields<B>>
-
- Type Parameters:
B
- the generic type
- All Superinterfaces:
java.util.Map<java.lang.String,java.util.List<java.lang.String>>
- All Known Subinterfaces:
FormFields
,HeaderFields<C,B>
,RequestHeaderFields
,ResponseHeaderFields
- All Known Implementing Classes:
AbstractHeaderFields
,AbstractHttpFields
,FormFieldsImpl
,RequestHeaderFieldsImpl
,ResponseHeaderFieldsImpl
public interface HttpFields<B extends HttpFields<B>> extends java.util.Map<java.lang.String,java.util.List<java.lang.String>>
Various key/value "collections" we run across when we develop HTTP based applications may have more then one value for one key. Such "collections" in this package are theHeaderFields
as well as theFormFields
. This interface represents this kind of data structure providing some common convenience methods.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default void
addTo(java.lang.Enum<?> aField, java.lang.String aValue)
Same asaddTo(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default void
addTo(java.lang.Enum<?> aField, java.lang.String... aValues)
Same asaddTo(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.default void
addTo(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same asaddTo(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.default void
addTo(java.lang.String aField, java.lang.String aValue)
Adds a value to the list of values associated with the given Header-Field (key).default void
addTo(java.lang.String aField, java.lang.String... aValues)
Adds values to the list of values associated with the given Header-Field (key).default void
addTo(java.lang.String aField, java.util.List<java.lang.String> aValues)
Adds values to the list of values associated with the given Header-Field (key),.default java.lang.String
getFirst(java.lang.Enum<?> aField)
Same asgetFirst(String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default java.lang.String
getFirst(java.lang.String aField)
Returns the first Header-Field value in the list of values associated with the given Header-Field.default java.util.List<java.lang.String>
put(java.lang.Enum<?> aField, java.lang.String aValue)
Same asput(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default java.util.List<java.lang.String>
put(java.lang.Enum<?> aField, java.lang.String... aValues)
Same asput(String, String ... )
though using the provided enumeration'sEnum.toString()
method to determine the key.default java.util.List<java.lang.String>
put(java.lang.String aField, java.lang.String aValue)
Sets a single value for the Header-Field (key).default java.util.List<java.lang.String>
put(java.lang.String aField, java.lang.String... aValues)
Performs a #set(String, String) on multiple values.default java.lang.String
toField(java.lang.Enum<?> aField)
Same astoField(String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default java.lang.String
toField(java.lang.String aKey)
This method returns a singleString
(instead of returning aList
ofString
instances when callingMap.get(Object)
) where the elements of the filed are separated by theDelimiter.HTTP_HEADER_ELEMENTS
and concatenated as a singleString
.default B
withAddTo(java.lang.Enum<?> aField, java.lang.String aValue)
Same aswithAddTo(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withAddTo(java.lang.Enum<?> aField, java.lang.String... aValues)
Same aswithAddTo(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withAddTo(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same aswithAddTo(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withAddTo(java.lang.String aField, java.lang.String aValue)
Builder method for theaddTo(String, String)
method.default B
withAddTo(java.lang.String aField, java.lang.String... aValues)
Builder method for theaddTo(String, String...)
method.default B
withAddTo(java.lang.String aField, java.util.List<java.lang.String> aValues)
Builder method for theaddTo(String, List)
method.default B
withPut(java.lang.Enum<?> aField, java.lang.String aValue)
Same aswithPut(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withPut(java.lang.Enum<?> aField, java.lang.String... aValues)
Same aswithPut(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withPut(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same aswithPut(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.default B
withPut(java.lang.String aField, java.lang.String aValue)
Builder method for theput(String, String)
method.default B
withPut(java.lang.String aField, java.lang.String... aValues)
Builder method for theput(String, String...)
method.default B
withPut(java.lang.String aField, java.util.List<java.lang.String> aValues)
Builder method for theMap.put(Object, Object)
method.-
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
-
-
-
-
Method Detail
-
getFirst
default java.lang.String getFirst(java.lang.String aField)
Returns the first Header-Field value in the list of values associated with the given Header-Field.- Parameters:
aField
- The Header-Field (key) of which's values the first value is to be retrieved.- Returns:
- The first value in the list of values associated to the given Header-Field (key).
-
getFirst
default java.lang.String getFirst(java.lang.Enum<?> aField)
Same asgetFirst(String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the field- Returns:
- the first
- See Also:
getFirst(String)
-
put
default java.util.List<java.lang.String> put(java.lang.String aField, java.lang.String aValue)
Sets a single value for the Header-Field (key). Any values previously associated to the given Header-Field (key) are lost.- Parameters:
aField
- The Header-Field for which to set a single value.aValue
- The single value to be set for the Header-Field (key).- Returns:
- the list
-
put
default java.util.List<java.lang.String> put(java.lang.Enum<?> aField, java.lang.String aValue)
Same asput(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValue
- the value- Returns:
- the list
- See Also:
put(String, String)
-
put
default java.util.List<java.lang.String> put(java.lang.String aField, java.lang.String... aValues)
Performs a #set(String, String) on multiple values.- Parameters:
aField
- The Header-Field for which to set the values.aValues
- The values to be set for the Header-Field (key).- Returns:
- the list
-
put
default java.util.List<java.lang.String> put(java.lang.Enum<?> aField, java.lang.String... aValues)
Same asput(String, String ... )
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- Returns:
- the list
- See Also:
put(String, String ...)
-
withPut
default B withPut(java.lang.String aField, java.lang.String aValue)
Builder method for theput(String, String)
method.- Parameters:
aField
- The Header-Field for which to set a single value.aValue
- The single value to be set for the Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withPut
default B withPut(java.lang.Enum<?> aField, java.lang.String aValue)
Same aswithPut(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValue
- the value- Returns:
- the b
- See Also:
withPut(String, String)
-
withPut
default B withPut(java.lang.String aField, java.util.List<java.lang.String> aValues)
Builder method for theMap.put(Object, Object)
method.- Parameters:
aField
- The Header-Field for which to set the values.aValues
- The values to be set for the Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withPut
default B withPut(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same aswithPut(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- Returns:
- the b
- See Also:
withPut(String, List)
-
withPut
default B withPut(java.lang.String aField, java.lang.String... aValues)
Builder method for theput(String, String...)
method.- Parameters:
aField
- The Header-Field for which to set the values.aValues
- The values to be set for the Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withPut
default B withPut(java.lang.Enum<?> aField, java.lang.String... aValues)
Same aswithPut(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- Returns:
- the b
- See Also:
withPut(String, String ...)
-
addTo
default void addTo(java.lang.String aField, java.lang.String aValue)
Adds a value to the list of values associated with the given Header-Field (key).- Parameters:
aField
- The Header-Field (key) of which's list of values a value is to be added.aValue
- The value to be added to the list of values associated to the given Header-Field (key).
-
addTo
default void addTo(java.lang.Enum<?> aField, java.lang.String aValue)
Same asaddTo(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValue
- the value- See Also:
addTo(String, String)
-
addTo
default void addTo(java.lang.String aField, java.lang.String... aValues)
Adds values to the list of values associated with the given Header-Field (key).- Parameters:
aField
- The Header-Field (key) of which's list of values the values are to be added.aValues
- The values to be added to the list of values associated to the given Header-Field (key).
-
addTo
default void addTo(java.lang.Enum<?> aField, java.lang.String... aValues)
Same asaddTo(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- See Also:
addTo(String, String ...)
-
addTo
default void addTo(java.lang.String aField, java.util.List<java.lang.String> aValues)
Adds values to the list of values associated with the given Header-Field (key),.- Parameters:
aField
- The Header-Field (key) of which's list of values the values are to be added.aValues
- The values to be added to the list of values associated to the given Header-Field (key).
-
addTo
default void addTo(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same asaddTo(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- See Also:
addTo(String, List)
-
withAddTo
default B withAddTo(java.lang.String aField, java.lang.String aValue)
Builder method for theaddTo(String, String)
method.- Parameters:
aField
- The Header-Field (key) of which's list of values a value is to be added.aValue
- The value to be added to the list of values associated to the given Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withAddTo
default B withAddTo(java.lang.Enum<?> aField, java.lang.String aValue)
Same aswithAddTo(String, String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValue
- the value- Returns:
- the b
- See Also:
withAddTo(String, String)
-
withAddTo
default B withAddTo(java.lang.String aField, java.lang.String... aValues)
Builder method for theaddTo(String, String...)
method.- Parameters:
aField
- The Header-Field (key) of which's list of values the values are to be added.aValues
- The values to be added to the list of values associated to the given Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withAddTo
default B withAddTo(java.lang.Enum<?> aField, java.lang.String... aValues)
Same aswithAddTo(String, String ...)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- Returns:
- the b
- See Also:
withAddTo(String, String ...)
-
withAddTo
default B withAddTo(java.lang.String aField, java.util.List<java.lang.String> aValues)
Builder method for theaddTo(String, List)
method.- Parameters:
aField
- The Header-Field (key) of which's list of values the values are to be added.aValues
- The values to be added to the list of values associated to the given Header-Field (key).- Returns:
- This
HttpFields
instance to continue building up the Header-Fields.
-
withAddTo
default B withAddTo(java.lang.Enum<?> aField, java.util.List<java.lang.String> aValues)
Same aswithAddTo(String, List)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the fieldaValues
- the values- Returns:
- the b
- See Also:
addTo(String, List)
-
toField
default java.lang.String toField(java.lang.String aKey)
This method returns a singleString
(instead of returning aList
ofString
instances when callingMap.get(Object)
) where the elements of the filed are separated by theDelimiter.HTTP_HEADER_ELEMENTS
and concatenated as a singleString
.- Parameters:
aKey
- The field's key for which's elements to retrieve a comma separatedString
- Returns:
- The comma separated
String
of the according elements or null if none such field was found.
-
toField
default java.lang.String toField(java.lang.Enum<?> aField)
Same astoField(String)
though using the provided enumeration'sEnum.toString()
method to determine the key.- Parameters:
aField
- the field- Returns:
- the string
- See Also:
toField(String)
-
-