Interface IAnnotationMap

  • All Superinterfaces:
    ISynchronizable, java.util.Map<Annotation,​Position>

    public interface IAnnotationMap
    extends java.util.Map<Annotation,​Position>, ISynchronizable
    An annotation map is a map specialized for the requirements of an annotation model. The annotation map supports a customizable lock object which is used to synchronize concurrent operations on the map (see ISynchronizable. The map supports two iterator methods, one for the values and one for the keys of the map. The returned iterators are robust, i.e. they work on a copy of the values and keys set that is made at the point in time the iterator methods are called.

    The returned collections of the methods values, entrySet, and keySet are not synchronized on the annotation map's lock object.

    Since:
    3.0
    See Also:
    IAnnotationModel
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Set<java.util.Map.Entry<Annotation,​Position>> entrySet()
      The returned set is not synchronized on this annotation map's lock object.
      java.util.Set<Annotation> keySet()
      The returned set is not synchronized on this annotation map's lock object.
      java.util.Iterator<Annotation> keySetIterator()
      Returns an iterator for a copy of this map's key set.
      java.util.Collection<Position> values()
      The returned collection is not synchronized on this annotation map's lock object.
      java.util.Iterator<Position> valuesIterator()
      Returns an iterator for a copy of this annotation map's values.
      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
    • Method Detail

      • valuesIterator

        java.util.Iterator<Position> valuesIterator()
        Returns an iterator for a copy of this annotation map's values.
        Returns:
        an iterator for a copy of this map's values
      • keySetIterator

        java.util.Iterator<Annotation> keySetIterator()
        Returns an iterator for a copy of this map's key set.
        Returns:
        an iterator for a copy of this map's key set
      • entrySet

        java.util.Set<java.util.Map.Entry<Annotation,​Position>> entrySet()
        The returned set is not synchronized on this annotation map's lock object.
        Specified by:
        entrySet in interface java.util.Map<Annotation,​Position>
      • keySet

        java.util.Set<Annotation> keySet()
        The returned set is not synchronized on this annotation map's lock object.
        Specified by:
        keySet in interface java.util.Map<Annotation,​Position>
      • values

        java.util.Collection<Position> values()
        The returned collection is not synchronized on this annotation map's lock object.
        Specified by:
        values in interface java.util.Map<Annotation,​Position>