Package org.biojavax

Class SimpleComment

java.lang.Object
org.biojava.utils.AbstractChangeable
org.biojavax.SimpleComment
All Implemented Interfaces:
Comparable, Changeable, Comment
public class SimpleComment extends AbstractChangeable implements Comment
An implementaion of Comment.
Since:
1.5
Author:
Richard Holland, gwaldon

  • Constructor Details

    • SimpleComment

      public SimpleComment(String comment, int rank)
      Constructs a new, immutable comment, given some text and a rank.
      Parameters:
      comment - the text of the comment. Cannot be null.
      rank - the rank of the comment.

    • SimpleComment

      protected SimpleComment()

  • Method Details

    • setComment

      protected void setComment(String comment)

    • getComment

      public String getComment()
      Returns the comment part of this comment.
      Specified by:
      getComment in interface Comment
      Returns:
      a comment.

    • setRank

      public void setRank(int rank) throws ChangeVetoException
      Sets the rank of this comment.
      Specified by:
      setRank in interface Comment
      Parameters:
      rank - the rank to use.
      Throws:
      ChangeVetoException - if the new rank is unacceptable.

    • getRank

      public int getRank()
      Returns the rank of this comment.
      Specified by:
      getRank in interface Comment
      Returns:
      the rank.

    • equals

      public boolean equals(Object obj)
      Two comments are defined as equal if their text values and rankings are identical.
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(Object o)
      Comments are ordered first by their rank, then by a string comparison of their text values.
      Specified by:
      compareTo in interface Comparable

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Form: "(#rank) comment"
      Overrides:
      toString in class Object

    • getId

      public Integer getId()
      Gets the Hibernate ID. Should be used with caution.
      Returns:
      the Hibernate ID, if using Hibernate.

    • setId

      public void setId(Integer id)
      Sets the Hibernate ID. Should be used with caution.
      Parameters:
      id - the Hibernate ID, if using Hibernate.