DatabaseConfiguration

@RMIWrap(DatabaseConfiguration.ConfigurationRMIWrapper.class)

public final class DatabaseConfiguration

saker.build.runtime.params.DatabaseConfiguration

java.lang.Object

Configuration class for specifying how the changes in the contents of the files should be determined.

The build system can detect changes in the used files in different ways. This configuration object allows specifying how the contents of different files should be treated. By default, the build system uses the last modification time and the size of the file to detect if a file changed between build executions.

The behaviour of the content detection can be specified using the ContentDescriptorSupplier interface. Common implementations of it is available in the CommonContentDescriptorSupplier enumeration.

The class allows specifying the content descriptor supplier implementations for wildcard patterns on given file providers. This means that the content descriptor supplier will be chosen based on the path to the file. If there is a matching wildcard for the path, the the associated content descriptor supplier is used to determine the contents of the file. If no matching wildcard is found, then the specified fallback content descriptor supplier is used.

If a path matches multiple wildcards, the associated content descriptor supplier to the first matching wildcard will be used that was added to the configuration.

Nested types

public static final class	Builder Builder class for DatabaseConfiguration.

Methods

public static Builder	builder() Creates a new builder with the default content descriptor supplier as a fallback supplier.
public static Builder	builder(ContentDescriptorSupplier fallbackContentSupplier) Creates a new builder with the given fallback content descriptor supplier.
public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public ContentDescriptorSupplier	getContentDescriptorSupplier(RootFileProviderKey providerkey, SakerPath path) Gets the content descriptor supplier to use for the given path at the specified file provider.
public static DatabaseConfiguration	getDefault() Gets the default database configuration that uses the default content descriptor supplier for all files.
public static ContentDescriptorSupplier	getDefaultFallbackContentDescriptorSupplier() Gets the default ContentDescriptorSupplier for paths which are not covered by the current DatabaseConfiguration for the execution.
public ContentDescriptorSupplier	getFallbackContentSupplier() Gets the fallback content descriptor supplier.
public int	hashCode() Returns a hash code value for the object.
public String	toString() Returns a string representation of the object.

Inherited methods
From: Object clone, finalize, getClass, notify, notifyAll, wait, wait, wait

public static Builder builder()

Creates a new builder with the default content descriptor supplier as a fallback supplier.

The new builder.

public static Builder builder(ContentDescriptorSupplier fallbackContentSupplier)

Creates a new builder with the given fallback content descriptor supplier.

fallbackContentSupplierThe fallback supplier.

The new builder.

getFallbackContentSupplier()

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.

Object.hashCode()

HashMap

public ContentDescriptorSupplier getContentDescriptorSupplier(RootFileProviderKey providerkey, SakerPath path)

Gets the content descriptor supplier to use for the given path at the specified file provider.

If no wildcard matches the path in this configuration, the fallback supplier is returned.

providerkeyThe provider key identifying the file provider.

pathThe path.

The content descriptor supplier to use.

public static DatabaseConfiguration getDefault()

Gets the default database configuration that uses the default content descriptor supplier for all files.

The default configuration.

getDefaultFallbackContentDescriptorSupplier()

public static ContentDescriptorSupplier getDefaultFallbackContentDescriptorSupplier()

Gets the default ContentDescriptorSupplier for paths which are not covered by the current DatabaseConfiguration for the execution.

By default, the build system uses the file attributes to determine the content descriptor. (File size, and last modification time)

The default fallback content descriptor supplier.

public ContentDescriptorSupplier getFallbackContentSupplier()

Gets the fallback content descriptor supplier.

The fallback supplier is used when no defined wildcard path matches the path currently being queried.

The fallback supplier.

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.

Object.equals(Object)

System.identityHashCode(Object)

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.