com.github.mangstadt.vinnie

Class VObjectParameters

java.lang.Object

com.github.mangstadt.vinnie.VObjectParameters

All Implemented Interfaces:

Iterable<Map.Entry<String,List<String>>>

public class VObjectParameters
extends Object
implements Iterable<Map.Entry<String,List<String>>>

A simple multimap implementation for holding the parameters of a VObjectProperty. Enforces case-insensitivity of parameter names by converting them to uppercase.

Author:

Michael Angstadt

Constructor Summary

Constructors

Constructor and Description
VObjectParameters() Creates an empty list of parameters.
VObjectParameters(Map<String,List<String>> map) Creates a list of parameters backed by the given map.
VObjectParameters(VObjectParameters original) Copies an existing list of parameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the multimap.
boolean	equals(Object obj)
String	first(String key) Gets the first value assigned to the given key.
List<String>	get(String key) Gets the values that are assigned to a key.
Charset	getCharset() Gets the CHARSET parameter.
Map<String,List<String>>	getMap() Gets the map that backs this parameters list.
int	hashCode()
boolean	isQuotedPrintable() Determines if a "quoted-printable encoding" parameter exists.
Iterator<Map.Entry<String,List<String>>>	iterator() Creates an iterator over all the parameters (for use in foreach loops).
void	put(String key, String value) Inserts a value.
void	putAll(String key, String... values) Inserts multiple values.
boolean	remove(String key, String value) Removes a value.
List<String>	removeAll(String key) Removes all values associated with a key, along with the key itself.
List<String>	replace(String key, String value) Replaces all the values of the given key with the given value.
List<String>	replaceAll(String key, String... values) Replaces all the values of the given key with the given values.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

VObjectParameters

public VObjectParameters()

Creates an empty list of parameters.

VObjectParameters

public VObjectParameters(Map<String,List<String>> map)

Creates a list of parameters backed by the given map. Any changes made to the given map will effect the parameter list and vice versa.

If the given map is not empty, care should be taken to ensure that all of its keys are in uppercase before passing it into this constructor.

Parameters:

map - the map

VObjectParameters

public VObjectParameters(VObjectParameters original)

Copies an existing list of parameters.

Parameters:

original - the existing list

Method Detail

get

public List<String> get(String key)

Gets the values that are assigned to a key.

Parameters:

key - the key

Returns:

the values or null if the key does not exist

put

public void put(String key,
                String value)

Inserts a value.

Parameters:

key - the key

value - the value to add

putAll

public void putAll(String key,
                   String... values)

Inserts multiple values.

Parameters:

key - the key

values - the values to add

replace

public List<String> replace(String key,
                            String value)

Replaces all the values of the given key with the given value.

Parameters:

key - the key

value - the value

Returns:

the replaced values or null if the key didn't exist

replaceAll

public List<String> replaceAll(String key,
                               String... values)

Replaces all the values of the given key with the given values.

Parameters:

key - the key

values - the values

Returns:

the replaced values or null if the key didn't exist

remove

public boolean remove(String key,
                      String value)

Removes a value.

Parameters:

key - the key

value - the value to remove

Returns:

true if the value was found, false if not

removeAll

public List<String> removeAll(String key)

Removes all values associated with a key, along with the key itself.

Parameters:

key - the key

Returns:

the removed values or null if the key didn't exist

clear

public void clear()

Clears the multimap.

first

public String first(String key)

Gets the first value assigned to the given key.

Parameters:

key - the key

Returns:

the value or null if the given key does not have any values

isQuotedPrintable

public boolean isQuotedPrintable()

Determines if a "quoted-printable encoding" parameter exists.

Returns:

true if the parameter exists, false if not

getCharset

public Charset getCharset()
                   throws IllegalCharsetNameException,
                          UnsupportedCharsetException

Gets the CHARSET parameter.

Returns:

the character set or null if a character set is not defined

Throws:

IllegalCharsetNameException - if the character set name contains illegal characters

UnsupportedCharsetException - if the local JVM does not recognized the character set

getMap

public Map<String,List<String>> getMap()

Gets the map that backs this parameters list.

Returns:

the map

iterator

public Iterator<Map.Entry<String,List<String>>> iterator()

Creates an iterator over all the parameters (for use in foreach loops).

Specified by:

iterator in interface Iterable<Map.Entry<String,List<String>>>

Returns:

the iterator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object