saker.build Documentation TaskDoc JavaDoc
public final class SimpleIDEConfiguration implements IDEConfiguration, Externalizable
Immutable IDEConfiguration data class implementation.

This class clones all the data passed to it during instantiation.

Constructors
public
public
SimpleIDEConfiguration(String type, String identifier, Map<String, ?> fields)
Creates a new instance by initializing it with the specified parameters.
public
Creates a new instance and intializes it by copying the data from the argument configuration.
Methods
public boolean
Indicates whether some other object is "equal to" this one.
public Object
getField(String fieldname)
Gets the value for a field in this configuration.
public Set<String>
Gets the field names present in this configuration.
public String
Gets an user readable identifier for this IDE configuration.
public String
Gets the type of this IDE configuration.
public int
Returns a hash code value for the object.
public void
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
public String
Returns a string representation of the object.
public void
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
Inherited methods
From: Object
public SimpleIDEConfiguration(String type, String identifier, Map<String, ?> fields) throws NullPointerException
Creates a new instance by initializing it with the specified parameters.

The fields will be copied recursively.

typeThe type of the IDE configuration.
identifierThe identifier for the IDE configuration.
fieldsThe fields to initialize this configuration with. If null, it is considered to be empty.
NullPointerExceptionIf type or identifier is null.
Creates a new instance and intializes it by copying the data from the argument configuration.
copyThe configuration to copy.
NullPointerExceptionIf the argument is null.
public boolean equals(Object obj)
Overridden from: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
public Object getField(String fieldname)
Overridden from: IDEConfiguration
Gets the value for a field in this configuration.

The field names can be arbitrary. They should represent their meaning for a project configuration. It is best that they are short and describe what kind of aspect they correspond to.

If a field has a multiple value then its name should be plural. (E.g. source_dirs, include_dirs)
Although it is not necessary if the usage does not require it. (E.g. both classpath and classpaths should be okay)

Field values should be boxed primitives, String, Collection, Map<String, ?> and compositions of their instances.

Any returned field values should be immutable.

fieldnameThe field name to look up.
The value of the field or null if it is not set.
Overridden from: IDEConfiguration
Gets the field names present in this configuration.

If a field name is present in this returned collection then IDEConfiguration.getField(String) should return non-null. It is an error to return null if the field name is present in this collection, but users of this class should be able to handle that gracefully.

An immutable collection of field names.
Overridden from: IDEConfiguration
Gets an user readable identifier for this IDE configuration.

This identifier should be based on a build step or location so the user can identify its correspondence to a build task. It is best if it's unique for a given IDE configuration type.

For example it can be an explicitly assigned identifier by the user, or a base source directory for the task which generated this configuration.

The identifier for this IDE configuration.
public String getType()
Overridden from: IDEConfiguration
Gets the type of this IDE configuration.

The type can be an arbitrary string which uniquely identifies a type of an IDE configuration. It is recommended that it is a dot separated name identified by the developer domain. (Like reverse domain naming in Java packages.)

The available field names for a given type should be documented by the developer of the given typed IDE configuration.

The type of this IDE configuration.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the Object.equals(Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

a hash code value for this object.
Overridden from: Externalizable
The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
a string representation of the object.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur