Package org.eclipse.scanning.api.event.status

Class StatusBean

java.lang.Object
org.eclipse.scanning.api.event.IdBean
org.eclipse.scanning.api.event.status.StatusBean
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CommandBean, PlanStatusBean, ScanBean, StepStatus, TaskBean
public class StatusBean extends IdBean
A bean whose JSON value can sit in a queue on the JMS server and provide information about state.
See Also:

  • Field Details

    • EMPTY

      public static final StatusBean EMPTY

    • previousStatus

      protected Status previousStatus

    • status

      protected Status status

    • name

      protected String name

    • message

      protected String message

    • percentComplete

      protected double percentComplete

    • userName

      protected String userName

    • hostName

      protected String hostName

    • estimatedTime

      protected long estimatedTime

    • startTime

      protected long startTime

    • submissionTime

      protected long submissionTime
      We intentionally ignore the JMS version of this

  • Constructor Details

    • StatusBean

      public StatusBean()

    • StatusBean

      public StatusBean(String name)

    • StatusBean

      public StatusBean(StatusBean statusBean)

  • Method Details

    • merge

      public <T extends IdBean> void merge(T with)
      Subclasses must override this method calling super.merge(...)
      Overrides:
      merge in class IdBean
      Parameters:
      with -

    • getStatus

      public Status getStatus()

    • setStatus

      public void setStatus(Status status)

    • getPercentComplete

      public double getPercentComplete()

    • setPercentComplete

      public void setPercentComplete(double percentComplete)

    • getStartTime

      public long getStartTime()

    • setStartTime

      public void setStartTime(long startTime)

    • getEstimatedTime

      public long getEstimatedTime()

    • setEstimatedTime

      public void setEstimatedTime(long estimatedTime)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class IdBean

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class IdBean

    • getName

      public String getName()

    • createName

      protected void createName()
      Override to generate a name automatically.

    • setName

      public void setName(String name)

    • getUserName

      public String getUserName()

    • setUserName

      public void setUserName(String userName)

    • getSubmissionTime

      public long getSubmissionTime()

    • setSubmissionTime

      public void setSubmissionTime(long submissionTime)

    • getMessage

      public String getMessage()

    • setMessage

      public void setMessage(String message)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getRunDirectory

      public String getRunDirectory()

    • setRunDirectory

      public void setRunDirectory(String visitDir)

    • getHostName

      public String getHostName()

    • setHostName

      public void setHostName(String hostName)

    • getProperties

      public Properties getProperties()

    • setProperties

      public void setProperties(Properties properties)

    • setProperty

      public void setProperty(String key, String value)

    • getProperty

      public String getProperty(String key)

    • getPreviousStatus

      public Status getPreviousStatus()

    • setPreviousStatus

      public void setPreviousStatus(Status previousStatus)