ProcessorConfiguration

package saker.java.compiler.api.processor

public interface ProcessorConfiguration

Represents a configuration for an annotation processor.

The configuration consists of a ProcessorCreator instance that defines how the processor can be instantiated for the annotation processing, and other properties that define the behaviour of the processor.

Clients shouldn't implement this interface.

You can create a new instance using create.

Methods

public static ProcessorConfiguration	create(ProcessorCreator creator) Creates a new processor configuration for the specified creator, and default behavioural properties.
public static ProcessorConfiguration	create(ProcessorCreator creator, boolean aggregating, boolean consistent, boolean alwaysrun) Creates a new processor configuration with the specified properties.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public boolean	getAggregating() Checks whether or not the processor is aggregating.
public boolean	getAlwaysRun() Checks whether or not the processor should always run.
public boolean	getConsistent() Checks whether or not the processor is consistent.
public ProcessorCreator	getCreator() Gets the processor creator that is used to instantiate the processor.
public int	hashCode() Returns a hash code value for the object.

public static ProcessorConfiguration create(ProcessorCreator creator) throws NullPointerException

Creates a new processor configuration for the specified creator, and default behavioural properties.

This is the same as:

 create(creator, true, true, false)

creatorThe processor creator.

The created configuration.

NullPointerExceptionIf the creator is null.

public static ProcessorConfiguration create(ProcessorCreator creator, boolean aggregating, boolean consistent, boolean alwaysrun) throws NullPointerException

Creates a new processor configuration with the specified properties.

creatorThe processor creator.

aggregatingTells whether or not the processor is aggregating. Pass true if you don't know.

consistentTells whether or not the processor is consistent. Pass true if you don't know.

alwaysrunTells whether or not the processor should always run. Pass false if you don't know.

The created configuration.

NullPointerExceptionIf the creator is null.

public abstract 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.

Object.hashCode()

HashMap

public abstract boolean getAggregating()

Checks whether or not the processor is aggregating.

A processor is considered to be Aggregating if there exists an addition-wise modification to the compiled Java classes that causes it to generate different classes or resources.

By default, the processors should be considered to be aggregating.

true if the processor is aggregating.

public abstract boolean getAlwaysRun()

Checks whether or not the processor should always run.

If a processor is configured to always run, then it will always be invoked even if there are no deltas detected for it.

By default, the processors shouldn't run always.

true if the processor should always run.

public abstract boolean getConsistent()

Checks whether or not the processor is consistent.

A processor is consistent if it produces the same result no matter the time of invocation. In general, if the processor generated resources based on the build time or other external untracked information, then it is not consistent.

By default, the processors should be considered to be consistent.

true if the processor is consistent.

public abstract ProcessorCreator getCreator()

Gets the processor creator that is used to instantiate the processor.

The creator.

public abstract 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.

Object.equals(Object)

System.identityHashCode(Object)