io.jsonwebtoken.lang

Interface MapMutator<K,V,T extends MapMutator<K,V,T>>

Type Parameters:

K - map key type

V - map value type

T - the mutator subtype, for method chaining

All Known Subinterfaces:

AsymmetricJwkBuilder<K,J,T>, ClaimsBuilder, DynamicJwkBuilder<K,J>, EcPrivateJwkBuilder, EcPublicJwkBuilder, HeaderMutator<T>, JweHeaderMutator<T>, JwkBuilder<K,J,T>, JwkSetBuilder, JwtBuilder.BuilderClaims, JwtBuilder.BuilderHeader, Jwts.HeaderBuilder, OctetPrivateJwkBuilder<K,L>, OctetPublicJwkBuilder<A,B>, PrivateJwkBuilder<K,L,J,M,T>, ProtectedHeaderMutator<T>, PublicJwkBuilder<K,L,J,M,P,T>, RsaPrivateJwkBuilder, RsaPublicJwkBuilder, SecretJwkBuilder

public interface MapMutator<K,V,T extends MapMutator<K,V,T>>

Mutation (modifications) to a Map instance while also supporting method chaining. The Map interface's Map.put(Object, Object), Map.remove(Object), Map.putAll(Map), and Map.clear() mutation methods do not support method chaining, so this interface enables that behavior.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	add(K key, V value) Sets the specified key/value pair in the map, overwriting any existing entry with the same key.
T	add(Map<? extends K,? extends V> m) Sets the specified key/value pairs in the map, overwriting any existing entries with the same keys.
T	delete(K key) Removes the map entry with the specified key.
T	empty() Removes all entries from the map.

Method Detail

delete

T delete(K key)

Removes the map entry with the specified key.

This method is the same as Map.remove, but instead returns the mutator instance for method chaining.

Parameters:

key - the key for the map entry to remove.

Returns:

the mutator/builder for method chaining.

empty

T empty()

Removes all entries from the map. The map will be empty after this call returns.

This method is the same as Map.clear, but instead returns the mutator instance for method chaining.

Returns:

the mutator/builder for method chaining.

add

T add(K key,
    V value)

Sets the specified key/value pair in the map, overwriting any existing entry with the same key. A null or empty value will remove the entry from the map entirely.

This method is the same as Map.put, but instead returns the mutator instance for method chaining.

Parameters:

key - the map key

value - the value to set for the specified header parameter name

Returns:

the mutator/builder for method chaining.

add

T add(Map<? extends K,? extends V> m)

Sets the specified key/value pairs in the map, overwriting any existing entries with the same keys. If any pair has a null or empty value, that pair will be removed from the map entirely.

This method is the same as Map.putAll, but instead returns the mutator instance for method chaining.

Parameters:

m - the map to add

Returns:

the mutator/builder for method chaining.