org.fife.ui.rsyntaxtextarea.templates.AbstractCodeTemplate Maven / Gradle / Ivy
The newest version!
/*
* 12/01/2008
*
* AbstractCodeTemplate.java - Base class for code templates.
*
* This library is distributed under a modified BSD license. See the included
* RSyntaxTextArea.License.txt file for details.
*/
package org.fife.ui.rsyntaxtextarea.templates;
/**
* A base class to build code templates on top of.
*
* @author Robert Futrell
* @version 1.0
*/
public abstract class AbstractCodeTemplate implements CodeTemplate {
/**
* The ID of this template.
*/
private String id;
/**
* This no-arg constructor is required for serialization purposes.
*/
public AbstractCodeTemplate() {
}
/**
* Creates a new template.
*
* @param id The ID for this template.
* @throws IllegalArgumentException If id is null.
*/
public AbstractCodeTemplate(String id) {
setID(id);
}
/**
* Creates a deep copy of this template.
*
* @return A deep copy of this template.
*/
@Override
public Object clone() {
// This method can't be abstract as compilers don't like concrete
// subclassses calling super.clone() on an abstract super.
try {
return super.clone();
} catch (CloneNotSupportedException e) {
throw new InternalError(
"CodeTemplate implementation not Cloneable: " +
getClass().getName());
}
}
/**
* Compares the StaticCodeTemplate to another.
*
* @param o Another StaticCodeTemplate object.
* @return A negative integer, zero, or a positive integer as this
* object is less than, equal-to, or greater than the passed-in
* object.
* @throws ClassCastException If o is
* not an instance of CodeTemplate.
*/
public int compareTo(CodeTemplate o) {
if (o==null) {
return -1;
}
return getID().compareTo(o.getID());
}
/**
* Overridden to return "true" iff
* {@link #compareTo(CodeTemplate)} returns 0.
*
* @return Whether this code template is equal to another.
*/
@Override
public boolean equals(Object obj) {
if (obj instanceof CodeTemplate) {
return compareTo(((CodeTemplate)obj))==0;
}
return false;
}
/**
* Returns the ID of this code template.
*
* @return The template's ID.
* @see #setID(String)
*/
public String getID() {
return id;
}
/**
* Returns the hash code for this template.
*
* @return The hash code for this template.
*/
@Override
public int hashCode() {
return id.hashCode();
}
/**
* Sets the ID for this template.
*
* @param id The ID for this template.
* @throws IllegalArgumentException If id is null.
* @see #getID()
*/
public void setID(String id) {
if (id==null) {
throw new IllegalArgumentException("id cannot be null");
}
this.id = id;
}
}