Class DefaultClipboard

All Implemented Interfaces:
Comparable<NamedBean>, PropertyChangeProvider, Base, Clipboard, NamedBean

public class DefaultClipboard
extends AbstractBase
implements Clipboard
Default implementation of the clipboard
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: Clipboard
      Is the clipboard empty?
      Specified by:
      isEmpty in interface Clipboard
      Returns:
      true if empty, false otherwise
    • add

      public boolean add​(MaleSocket maleSocket, List<String> errors)
      Description copied from interface: Clipboard
      Add an item to the clipboard.

      The last added item is on the top of the clipboard.

      Specified by:
      add in interface Clipboard
      Parameters:
      maleSocket - the item to add on the clipboard
      errors - a list of potential errors
      Returns:
      true if success, false otherwise
    • fetchTopItem

      Description copied from interface: Clipboard
      Get the top item on the clipboard and remove it from the clipboard.

      The top item is the last item put on the clipboard

      Specified by:
      fetchTopItem in interface Clipboard
      Returns:
      the top item
    • getTopItem

      Description copied from interface: Clipboard
      Get the top item on the clipboard without removing it from the clipboard.

      The top item is the last item put on the clipboard

      Specified by:
      getTopItem in interface Clipboard
      Returns:
      the top item
    • getFemaleSocket

      Description copied from interface: Clipboard
      Get the female socket root of the clipboard tree.
      Specified by:
      getFemaleSocket in interface Clipboard
      Returns:
      the root female socket
    • moveItemToTop

      public void moveItemToTop​(MaleSocket maleSocket)
      Description copied from interface: Clipboard
      Moves an item on the clipboard to the top of the clipboard.

      If an item on the clipboard that is not the top item is cut, it's placed as the top item on the clipboard until it's pasted elsewhere.

      Specified by:
      moveItemToTop in interface Clipboard
      Parameters:
      maleSocket - the male socket to put on the top
    • setup

      public void setup()
      Description copied from interface: Clipboard
      Setup this object and its children. This method is used to lookup system names for child sockets.
      Specified by:
      setup in interface Base
      Specified by:
      setup in interface Clipboard
    • replaceClipboardItems

      public boolean replaceClipboardItems​(ClipboardMany clipboardItems, List<String> errors)
    • registerListenersForThisClass

      Description copied from class: AbstractBase
      Register listeners if this object needs that.

      Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not registered more than once.

      Specified by:
      registerListenersForThisClass in class AbstractBase
    • unregisterListenersForThisClass

      Description copied from class: AbstractBase
      Unregister listeners if this object needs that.

      Important: This method may be called more than once. Methods overriding this method must ensure that listeners are not unregistered more than once.

      Specified by:
      unregisterListenersForThisClass in class AbstractBase
    • disposeMe

      protected void disposeMe()
      Description copied from class: AbstractBase
      Dispose this class. Listeners do not need to be unregistered by this method since they are unregistered by dispose().
      Specified by:
      disposeMe in class AbstractBase
    • setState

      public void setState​(int s) throws JmriException
      Description copied from interface: NamedBean
      Provide generic access to internal state.

      This generally shouldn't be used by Java code; use the class-specific form instead (e.g. setCommandedState in Turnout). This is provided to make scripts access easier to read.

      Specified by:
      setState in interface NamedBean
      Parameters:
      s - the state
      Throws:
      JmriException - general error when setting the state fails
    • getState

      public int getState()
      Description copied from interface: NamedBean
      Provide generic access to internal state.

      This generally shouldn't be used by Java code; use the class-specific form instead (e.g. getCommandedState in Turnout). This is provided to make scripts easier to read.

      Specified by:
      getState in interface NamedBean
      Returns:
      the state
    • getBeanType

      public String getBeanType()
      Description copied from interface: NamedBean
      For instances in the code where we are dealing with just a bean and a message needs to be passed to the user or in a log.
      Specified by:
      getBeanType in interface NamedBean
      Returns:
      a string of the bean type, eg Turnout, Sensor etc
    • getDeepCopy

      public Base getDeepCopy​(Map<String,​String> systemNames, Map<String,​String> userNames) throws JmriException
      Description copied from interface: Base
      Create a deep copy of myself and my children The item needs to try to lookup itself in both systemNames and userNames to see if the user has given a new system name and/or a new user name.If no new system name is given, an auto system name is used. If no user name is given, a null user name is used.
      Specified by:
      getDeepCopy in interface Base
      Parameters:
      systemNames - a map of old and new system name
      userNames - a map of old system name and new user name
      Returns:
      a deep copy
      Throws:
      JmriException - in case of an error
    • getShortDescription

      public String getShortDescription​(Locale locale)
      Description copied from interface: Base
      Get a short description of this item.
      Specified by:
      getShortDescription in interface Base
      Parameters:
      locale - The locale to be used
      Returns:
      a short description
    • getLongDescription

      public String getLongDescription​(Locale locale)
      Description copied from interface: Base
      Get a long description of this item.
      Specified by:
      getLongDescription in interface Base
      Parameters:
      locale - The locale to be used
      Returns:
      a long description
    • getParent

      public Base getParent()
      Description copied from interface: Base
      Get the parent.

      The following rules apply

      • LogixNGs has no parent. The method throws an UnsupportedOperationException if called.
      • Expressions and actions has the male socket that they are connected to as their parent.
      • Male sockets has the female socket that they are connected to as their parent.
      • The parent of a female sockets is the LogixNG, expression or action that has this female socket.
      • The parent of a male sockets is the same parent as the expression or action that it contains.
      Specified by:
      getParent in interface Base
      Returns:
      the parent of this object
    • setParent

      public void setParent​(Base parent)
      Description copied from interface: Base
      Set the parent.

      The following rules apply

      • ExecutionGroups has no parent. The method throws an UnsupportedOperationException if called.
      • LogixNGs has the execution group as its parent.
      • Expressions and actions has the male socket that they are connected to as their parent.
      • Male sockets has the female socket that they are connected to as their parent.
      • The parent of a female sockets is the LogixNG, expression or action that has this female socket.
      • The parent of a male sockets is the same parent as the expression or action that it contains.
      Specified by:
      setParent in interface Base
      Parameters:
      parent - the new parent of this object
    • getChild

      Description copied from interface: Base
      Get a child of this item
      Specified by:
      getChild in interface Base
      Parameters:
      index - the index of the child to get
      Returns:
      the child
      Throws:
      IllegalArgumentException - if the index is less than 0 or greater or equal with the value returned by getChildCount()
      UnsupportedOperationException
    • getChildCount

      public int getChildCount()
      Description copied from interface: Base
      Get the number of children.
      Specified by:
      getChildCount in interface Base
      Returns:
      the number of children
    • getCategory

      Description copied from interface: Base
      Get the category.
      Specified by:
      getCategory in interface Base
      Returns:
      the category
    • isExternal

      public boolean isExternal()
      Description copied from interface: Base
      Is this external? Does it affects or is dependent on external things, like turnouts and sensors? Timers are considered as internal since they behavies the same on every computer on every layout.
      Specified by:
      isExternal in interface Base
      Returns:
      true if this is external