saker.build Documentation TaskDoc JavaDoc Packages
public final class SimplePathKey extends BasicPathKey implements Externalizable
Simple PathKey implementation only holding the necessary attributes.
Constructors
public
public
Use valueOf(PathKey) instead to avoid creating many instances.
public
Creates a path key for the given argument members.
public
Creates a new path key for a given path and the provider key is derived from the provider argument.
Methods
public RootFileProviderKey
Gets the root file provider key that is associated with the path.
public SakerPath
Gets the path of the file location.
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 static SimplePathKey
valueOf(PathKey pathkey)
Gets a new path key instance by copying the members from the argument.
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.
Use valueOf(PathKey) instead to avoid creating many instances.
Creates a new path key instance by copying the members from the argument.

The path and provider key will be initialized from the argument.

pathkeyThe path key to base this instance on.
NullPointerExceptionIf the argument is null.
Creates a path key for the given argument members.
pathThe path.
providerKeyThe file provider key.
NullPointerExceptionIf any of the arguments are null.
IllegalArgumentExceptionIf the path is not absolute.
Creates a new path key for a given path and the provider key is derived from the provider argument.

The file provider argument must be a root file provider.

No further checks are made on the arguments. The path may not point to a valid path on the file provider. I.e. it is not checked that the path has a valid root on the file provider.

fileProviderThe file provider.
pathThe path.
NullPointerExceptionIf any of the arguments are null.
IllegalArgumentExceptionIf the file provider is not a root provider or if the path is not absolute.
Overridden from: PathKey
Gets the root file provider key that is associated with the path.
The root file provider.
Overridden from: PathKey
Gets the path of the file location.
The path.
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 static SimplePathKey valueOf(PathKey pathkey) throws NullPointerException
Gets a new path key instance by copying the members from the argument.

The method only creates a new instance if the argument is not already a SimplePathKey. If it is, then it's simply returned.

The path and provider key will be initialized from the argument.

pathkeyThe path key to base this instance on.
The path key that is either copied from the argument, or is the same.
NullPointerExceptionIf the argument is null.
saker.build 0.8.19
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