Class 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.
    • Method Detail

      • of

        public static <K,​V> Relation<K,​V> of​(Map<K,​Set<V>> map,
                                                         Class<?> setCreator)
      • clear

        public void clear()
      • containsKey

        public boolean containsKey​(Object key)
      • containsValue

        public boolean containsValue​(Object value)
      • 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()
      • 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 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​(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<K>
      • freeze

        public Relation<K,​V> freeze()
        Description copied from interface: Freezable
        Freezes the object.
        Specified by:
        freeze in interface Freezable<K>
        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<K>
      • removeAll

        public boolean removeAll​(Relation<K,​V> toBeRemoved)
      • removeAll

        public Set<V> removeAll​(K... keys)
      • removeAll

        public boolean removeAll​(K key,
                                 Iterable<V> toBeRemoved)