Modification Class Reference

Inheritance diagram for Modification:

[legend]

Collaboration diagram for Modification:

[legend]

List of all members.

Public Member Functions
	Modification ()
	Default constructor.
Date	getTimestamp ()
	Get modification timestamp.
Modification	setTimestamp (Date timestamp)
	Set modification timestamp.
String	getModifier ()
	Get the name of the person who made this modification.
Modification	setModifier (String modifier)
	Set the name of the person who made this modification.
String	getComment ()
	Get the modification comment (may be null).
Modification	setComment (String comment)
	Set the modification comment (may be null).
Modification	unsetComment ()
	Unset the modification comment.
int	compareTo (Modification other)
String	toString ()
	Default String representation: declares that method is not properly defined by default.
boolean	equals (Object other)
int	hashCode ()
Package Functions
Logger	log ()
	Neat method to allow every class to get hold of a custom-named Logger.

---

Detailed Description

Definition at line 10 of file Modification.java.

---

Constructor & Destructor Documentation

Modification

(

)

Default constructor.

Definition at line 30 of file Modification.java.

{}

---

Member Function Documentation

Date getTimestamp

(

)

Get modification timestamp.

Definition at line 37 of file Modification.java.

Referenced by Modification.compareTo(), Modification.hashCode(), and Modification.toString().

                               {
        return _timestamp;
    }

Modification setTimestamp

(

Date

timestamp

)

Set modification timestamp.

Definition at line 41 of file Modification.java.

                                                     {
        _timestamp = timestamp;
        return this;
    }

String getModifier

(

)

Get the name of the person who made this modification.

Definition at line 48 of file Modification.java.

Referenced by Modification.hashCode(), and Modification.toString().

                                {
        return _modifier;
    }

Modification setModifier

(

String

modifier

)

Set the name of the person who made this modification.

Definition at line 52 of file Modification.java.

                                                     {
        _modifier = modifier;
        return this;
    }

String getComment

(

)

Get the modification comment (may be null).

Definition at line 59 of file Modification.java.

Referenced by Modification.hashCode(), and Modification.toString().

                               {
        return _comment;
    }

Modification setComment

(

String

comment

)

Set the modification comment (may be null).

Definition at line 63 of file Modification.java.

                                                   {
        _comment = comment;
        return this;
    }

Modification unsetComment

(

)

Unset the modification comment.

Definition at line 68 of file Modification.java.

                                       {
        _comment = null;
        return this;
    }

int compareTo

(

Modification

other

)

Definition at line 77 of file Modification.java.

References Modification.getTimestamp(), and Storeable.log().

                                             {
        log().debug("Comparing modifications...");
        if (getTimestamp() == null) {
            log().warn("Null timestamp");
            return 1; // Sort null at the end
        } else if (getTimestamp().after(other.getTimestamp())) {
            log().debug("Greater than");
            return 1;
        } else if (getTimestamp().before(other.getTimestamp())) {
            log().debug("Less than");
            return -1;
        } else {
            log().debug("Equal to");
            return 0;
        }
    }

String toString

(

)

Default String representation: declares that method is not properly defined by default.

Reimplemented from Storeable.

Definition at line 98 of file Modification.java.

References Modification.getComment(), Modification.getModifier(), and Modification.getTimestamp().

                             {
        StringBuffer s = new StringBuffer();
        s.append(getTimestamp().toString() + ", ");
        s.append(getModifier() + "\n");
        s.append(getComment());
        return s.toString();
    }

boolean equals

(

Object

other

)

Definition at line 107 of file Modification.java.

References Modification.hashCode().

                                        {
        if (this == other) return true;
        if (! (other instanceof Modification)) return false;
        return hashCode() == other.hashCode();
    }

int hashCode

(

)

Definition at line 114 of file Modification.java.

References Modification.getComment(), Modification.getModifier(), and Modification.getTimestamp().

Referenced by Modification.equals().

                          {
        int code = 53;
        if (getTimestamp() != null) code ^= getTimestamp().hashCode();
        if (getModifier() != null)  code ^= getModifier().hashCode();
        if (getComment() != null)   code ^= getComment().hashCode();
        return code;
    }

Logger log

(

)

[package, inherited]

Neat method to allow every class to get hold of a custom-named Logger.

Definition at line 14 of file Storeable.java.

Referenced by Uncertainty.compareTo(), Reference.compareTo(), PointError.compareTo(), Modification.compareTo(), Experiment.compareTo(), DatasetError.compareTo(), AxisError.compareTo(), Data.makeExample(), Data.makeExampleDataset(), Data.makeExampleExperiment(), Data.makeExamplePaper(), Data.makeExampleXAxes(), Data.makeExampleYAxes(), AxisError.setAxis(), DatasetError.setDataset(), DatasetError.setNormType(), PointError.setPoint(), and Uncertainty.toString().

                 {
        return Logger.getLogger(this.getClass());
    }

---

The documentation for this class was generated from the following file:

• /home/buckley/hepdata/codedocs/src/hepdata/hepdata-model/src/main/java/cedar/hepdata/model/Modification.java