JavaSourceDirectory

package saker.java.compiler.api.classpath

public interface JavaSourceDirectory

Represents a source directory configuration.

The interface provides access to the execution path of the source directory and the files that should be considered.

Clients shouldn't implement this interface.

Use create to create a new instance.

Methods

public static JavaSourceDirectory	create(SakerPath directorypath) Creates a new instance for the specified directory.
public static JavaSourceDirectory	create(SakerPath directorypath, Collection<? extends WildcardPath> files) Creates a new instance for the specified directory and wildcard filters.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public SakerPath	getDirectory() Gets the absolute build execution path to the source directory.
public Set<? extends WildcardPath>	getFiles() Gets the wildcards that specify the files that are used under the source directory.
public int	hashCode() Returns a hash code value for the object.

public static JavaSourceDirectory create(SakerPath directorypath) throws NullPointerException, InvalidPathFormatException

Creates a new instance for the specified directory.

Same as:

 create(directorypath, null)

directorypathThe absolute build execution path to the directory.

The created configuration.

NullPointerExceptionIf the directory path is null.

InvalidPathFormatExceptionIf the path is not absolute.

public static JavaSourceDirectory create(SakerPath directorypath, Collection<? extends WildcardPath> files) throws NullPointerException, InvalidPathFormatException

Creates a new instance for the specified directory and wildcard filters.

directorypathThe absolute build execution path to the directory.

filesThe wildcards that match the source files or null to use the defaults.

The created configuration.

NullPointerExceptionIf the directory path is null.

InvalidPathFormatExceptionIf the path is not absolute.

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 SakerPath getDirectory()

Gets the absolute build execution path to the source directory.

The directory path.

public abstract Set<? extends WildcardPath> getFiles()

Gets the wildcards that specify the files that are used under the source directory.

The wildcards are used to match the relative paths of the source files from the source directory.

If null are specified, then all files are considered that have the .java (ignore-case) extension. (Note that an empty collection doesn't signal that the defaults should be used.)

The wildcard for the matching files or null to use the defaults.

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)