Class StrokeMap

  • All Implemented Interfaces:
    Serializable, Cloneable

    public class StrokeMap
    extends Object
    implements Cloneable, Serializable
    A storage structure that maps Comparable instances with Stroke instances.

    To support cloning and serialization, you should only use keys that are cloneable and serializable. Special handling for the Stroke instances is included in this class.
    Since:
    1.0.3
    See Also:
    Serialized Form
    • Constructor Detail

      • StrokeMap

        public StrokeMap()
        Creates a new (empty) map.
    • Method Detail

      • getStroke

        public Stroke getStroke​(Comparable key)
        Returns the stroke associated with the specified key, or null.
        Parameters:
        key - the key (null not permitted).
        Returns:
        The stroke, or null.
        Throws:
        IllegalArgumentException - if key is null.
      • containsKey

        public boolean containsKey​(Comparable key)
        Returns true if the map contains the specified key, and false otherwise.
        Parameters:
        key - the key.
        Returns:
        true if the map contains the specified key, and false otherwise.
      • put

        public void put​(Comparable key,
                        Stroke stroke)
        Adds a mapping between the specified key and stroke values.
        Parameters:
        key - the key (null not permitted).
        stroke - the stroke.
      • clear

        public void clear()
        Resets the map to empty.
      • equals

        public boolean equals​(Object obj)
        Tests this map for equality with an arbitrary object.
        Overrides:
        equals in class Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.