Package lib.aide.resource.collection

Record Class PathElaboration

java.lang.Object

java.lang.Record

lib.aide.resource.collection.PathElaboration

public record PathElaboration(ResourceFactory.MapFromTextResult elaboration, ResourceProvenance<?,Resource<? extends Nature,?>> rp, List<Map.Entry<String,Paths.DeepMergeOperation>> merged)
extends Record

Constructor Summary

Constructors

Constructor	Description
PathElaboration(ResourceFactory.MapFromTextResult elaboration, ResourceProvenance<?,Resource<? extends Nature,?>> rp, List<Map.Entry<String,Paths.DeepMergeOperation>> merged)	Creates an instance of a PathElaboration record class.

Method Summary

Modifier and Type	Method	Description
ResourceFactory.MapFromTextResult	elaboration()	Returns the value of the elaboration record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static <T extends Provenance> Optional<PathElaboration>	fromBasename(String basename, Paths<String,ResourceProvenance<T,Resource<? extends Nature,?>>>.Node parent, Paths<String,ResourceProvenance<T,Resource<? extends Nature,?>>>.Node newNode)	If the file is `.path.yml` `.path.yaml` or `.path.json` or `.
final int	hashCode()	Returns a hash code value for this object.
List<Map.Entry<String,Paths.DeepMergeOperation>>	merged()	Returns the value of the merged record component.
ResourceProvenance<?,Resource<? extends Nature,?>>	rp()	Returns the value of the rp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PathElaboration

public PathElaboration(ResourceFactory.MapFromTextResult elaboration,
 ResourceProvenance<?,Resource<? extends Nature,?>> rp,
 List<Map.Entry<String,Paths.DeepMergeOperation>> merged)

Creates an instance of a PathElaboration record class.

Parameters:

elaboration - the value for the elaboration record component

rp - the value for the rp record component

merged - the value for the merged record component

Method Details

fromBasename

public static <T extends Provenance>
Optional<PathElaboration> fromBasename(String basename,
 Paths<String,ResourceProvenance<T,Resource<? extends Nature,?>>>.Node parent,
 Paths<String,ResourceProvenance<T,Resource<? extends Nature,?>>>.Node newNode)

If the file is `.path.yml` `.path.yaml` or `.path.json` or `.[parent-dir-name].path.yml` or `[parent-dir-name].path.yml` or `.yaml` or `.json` it's a special file which "elaborates" the current path, not a content resource. Usually this means we just take all the contents of the file and merge them as the parent node's attributes.

Parameters:

basename - the basename to test

parent - the parent to test

Returns:

true if the basename contains path elaboration content

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

elaboration

public ResourceFactory.MapFromTextResult elaboration()

Returns the value of the elaboration record component.

Returns:

the value of the elaboration record component

rp

public ResourceProvenance<?,Resource<? extends Nature,?>> rp()

Returns the value of the rp record component.

Returns:

the value of the rp record component

merged

public List<Map.Entry<String,Paths.DeepMergeOperation>> merged()

Returns the value of the merged record component.

Returns:

the value of the merged record component