Relation (moe.ios.core API)

java.lang.Object
- com.ibm.icu.impl.Relation<K,V>

All Implemented Interfaces:

Freezable<Relation<K,V>>, Cloneable
```
public class Relation<K,V>
extends Object
implements Freezable<Relation<K,V>>
```
A Relation is a set of mappings from keys to values. Unlike Map, there is not guaranteed to be a single value per key. The Map-like APIs return collections for values.

Constructor Summary

Constructors
Constructor and Description
`Relation(Map<K,Set<V>> map, Class<?> setCreator)`
`Relation(Map<K,Set<V>> map, Class<?> setCreator, Comparator<V> setComparator)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Relation<K,V>`	`addAllInverted(Map<V,K> source)`
`Relation<K,V>`	`addAllInverted(Relation<V,K> source)`
`void`	`clear()`
`Relation<K,V>`	`cloneAsThawed()` Provides for the clone operation.
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<K,V>>`	`entrySet()`
`boolean`	`equals(Object o)` Compares this instance with the specified object and indicates if they are equal.
`Relation<K,V>`	`freeze()` Freezes the object.
`Set<V>`	`get(Object key)`
`Set<V>`	`getAll(Object key)`
`int`	`hashCode()` Returns an integer hash code for this object.
`boolean`	`isEmpty()`
`boolean`	`isFrozen()` Determines whether the object has been frozen or not.
`Set<K>`	`keySet()`
`Set<Map.Entry<K,V>>`	`keyValueSet()`
`Set<Map.Entry<K,Set<V>>>`	`keyValuesSet()`
`static <K,V> Relation<K,V>`	`of(Map<K,Set<V>> map, Class<?> setCreator)`
`static <K,V> Relation<K,V>`	`of(Map<K,Set<V>> map, Class<?> setCreator, Comparator<V> setComparator)`
`V`	`put(K key, V value)`
`V`	`putAll(Collection<K> keys, V value)`
`V`	`putAll(K key, Collection<? extends V> values)`
`void`	`putAll(Map<? extends K,? extends V> t)`
`void`	`putAll(Relation<? extends K,? extends V> t)`
`boolean`	`remove(K key, V value)`
`Set<V>`	`removeAll(Collection<K> toBeRemoved)`
`Set<V>`	`removeAll(K... keys)`
`Set<V>`	`removeAll(K key)`
`boolean`	`removeAll(K key, Iterable<V> toBeRemoved)`
`boolean`	`removeAll(Relation<K,V> toBeRemoved)`
`int`	`size()`
`String`	`toString()` Returns a string containing a concise, human-readable description of this object.
`Set<V>`	`values()`
`<C extends Collection<V>> C`	`values(C result)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Relation
```
public Relation(Map<K,Set<V>> map,
                Class<?> setCreator)
```
  - Relation
```
public Relation(Map<K,Set<V>> map,
                Class<?> setCreator,
                Comparator<V> setComparator)
```
- Method Detail
  - of
```
public static <K,V> Relation<K,V> of(Map<K,Set<V>> map,
                                     Class<?> setCreator)
```
  - of
```
public static <K,V> Relation<K,V> of(Map<K,Set<V>> map,
                                     Class<?> setCreator,
                                     Comparator<V> setComparator)
```
  - clear
```
public void clear()
```
  - containsKey
```
public boolean containsKey(Object key)
```
  - containsValue
```
public boolean containsValue(Object value)
```
  - entrySet
```
public final Set<Map.Entry<K,V>> entrySet()
```
  - keyValuesSet
```
public Set<Map.Entry<K,Set<V>>> keyValuesSet()
```
  - keyValueSet
```
public Set<Map.Entry<K,V>> keyValueSet()
```
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: Object
    
    Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.
    The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.
    The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to compare this instance with.
    
    Returns:
    
    true if the specified object is equal to this Object; false otherwise.
    
    See Also:
    
    Object.hashCode()
  - getAll
```
public Set<V> getAll(Object key)
```
  - get
```
public Set<V> get(Object key)
```
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    
    Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.
    Note that hash values must not change over time unless information used in equals comparisons also changes.
    See Writing a correct hashCode method if you intend implementing your own hashCode method.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    this object's hash code.
    
    See Also:
    
    Object.equals(java.lang.Object)
  - isEmpty
```
public boolean isEmpty()
```
  - keySet
```
public Set<K> keySet()
```
  - put
```
public V put(K key,
             V value)
```
  - putAll
```
public V putAll(K key,
                Collection<? extends V> values)
```
  - putAll
```
public V putAll(Collection<K> keys,
                V value)
```
  - putAll
```
public void putAll(Map<? extends K,? extends V> t)
```
  - putAll
```
public void putAll(Relation<? extends K,? extends V> t)
```
  - removeAll
```
public Set<V> removeAll(K key)
```
  - remove
```
public boolean remove(K key,
                      V value)
```
  - size
```
public int size()
```
  - values
```
public Set<V> values()
```
  - values
```
public <C extends Collection<V>> C values(C result)
```
  - toString
```
public String toString()
```
    Description copied from class: Object
    Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:
```
   getClass().getName() + '@' + Integer.toHexString(hashCode())
```
    See Writing a useful toString method if you intend implementing your own toString method.
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a printable representation of this object.
  - addAllInverted
```
public Relation<K,V> addAllInverted(Relation<V,K> source)
```
  - addAllInverted
```
public Relation<K,V> addAllInverted(Map<V,K> source)
```
  - isFrozen
```
public boolean isFrozen()
```
    Description copied from interface: Freezable
    
    Determines whether the object has been frozen or not.
    
    Specified by:
    
    isFrozen in interface Freezable<Relation<K,V>>
  - freeze
```
public Relation<K,V> freeze()
```
    Description copied from interface: Freezable
    
    Freezes the object.
    
    Specified by:
    
    freeze in interface Freezable<Relation<K,V>>
    
    Returns:
    
    the object itself.
  - cloneAsThawed
```
public Relation<K,V> cloneAsThawed()
```
    Description copied from interface: Freezable
    
    Provides for the clone operation. Any clone is initially unfrozen.
    
    Specified by:
    
    cloneAsThawed in interface Freezable<Relation<K,V>>
  - removeAll
```
public boolean removeAll(Relation<K,V> toBeRemoved)
```
  - removeAll
```
public Set<V> removeAll(K... keys)
```
  - removeAll
```
public boolean removeAll(K key,
                         Iterable<V> toBeRemoved)
```
  - removeAll
```
public Set<V> removeAll(Collection<K> toBeRemoved)
```

Class Relation<K,V>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Relation

Relation

Method Detail

of

of

clear

containsKey

containsValue

entrySet

keyValuesSet

keyValueSet

equals

getAll

get

hashCode

isEmpty

keySet

put

putAll

putAll

putAll

putAll

removeAll

remove

size

values

values

toString

addAllInverted

addAllInverted

isFrozen

freeze

cloneAsThawed

removeAll

removeAll

removeAll

removeAll