org.javasimon.Sample Maven / Gradle / Ivy
package org.javasimon;
import org.javasimon.utils.SimonUtils;
import java.io.Serializable;
/**
* Sample contains all relevant values of the Simon that are obtained by the
* {@link org.javasimon.Simon#sample()} and {@link org.javasimon.Simon#sampleIncrement(Object)} methods.
* Returned object contains consistent set of Simon values as both operations are synchronized.
* However Sample is a Java Bean and it can be modified afterwards so no consistency is guaranteed
* when the object is used in an inappropriate context. As a Java Bean object can be
* used directly as the data transfer object without need to create another DTO with the same data.
* Sample generally doesn't have any behavior.
*
* @author Richard "Virgo" Richter
*/
public abstract class Sample implements Serializable {
private String name;
private String note;
private long firstUsage;
private long lastUsage;
/**
* Name of the sampled Simon.
*
* @return Simon's name
*/
public final String getName() {
return name;
}
/**
* Sets the name of the sampled Simon - mostly not used directly.
*
* @param name Simon's name
*/
public final void setName(String name) {
this.name = name;
}
/**
* Note from the sampled Simon.
*
* @return Simon's note
*/
public final String getNote() {
return note;
}
/**
* Sets the note for the sample, typically note from the sampled Simon.
*
* @param note Simon's note
*/
public final void setNote(String note) {
this.note = note;
}
/**
* Timestamp of the first usage from the sampled Simon.
*
* @return Simon's first usage timestamp
*/
public long getFirstUsage() {
return firstUsage;
}
/**
* Sets the timestamp of the first usage from the sampled Simon.
*
* @param firstUsage Simon's first usage timestamp
*/
public void setFirstUsage(long firstUsage) {
this.firstUsage = firstUsage;
}
/**
* Timestamp of the last usage from the sampled Simon.
*
* @return Simon's last usage timestamp
*/
public long getLastUsage() {
return lastUsage;
}
/**
* Sets the timestamp of the last usage from the sampled Simon.
*
* @param lastUsage Simon's last usage timestamp
*/
public void setLastUsage(long lastUsage) {
this.lastUsage = lastUsage;
}
// common part of the toString method
void toStringCommon(StringBuilder sb) {
sb.append(", firstUsage=").append(SimonUtils.presentTimestamp(getFirstUsage()));
sb.append(", lastUsage=").append(SimonUtils.presentTimestamp(getLastUsage()));
sb.append(", note=").append(getNote());
sb.append('}');
}
/** Similar to {@link org.javasimon.AbstractSimon#toString()} except for the state missing in the output. */
public abstract String simonToString();
String simonToStringCommon() {
return " [" + name + (getNote() != null && getNote().length() != 0 ? " \"" + getNote() + "\"]" : "]");
}
}