Record Class WorkingSet.Member

java.lang.Object

java.lang.Record

network.ike.workspace.WorkingSet.Member

Record Components:

name - the subproject name, or the directory name for the workspace root and for a single repository

directory - the git working tree's directory

kind - whether this member is a declared subproject or the workspace root (aggregator)

Enclosing class:

WorkingSet

public static record WorkingSet.Member(String name, Path directory, WorkingSet.Member.Kind kind)
extends Record

One git working tree in a WorkingSet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkingSet.Member.Kind	The role a WorkingSet.Member plays in its WorkingSet.

Constructor Summary

Constructors

Constructor	Description
Member(String name, Path directory, WorkingSet.Member.Kind kind)	Creates an instance of a Member record class.

Method Summary

Modifier and Type	Method	Description
static WorkingSet.Member	aggregator(String name, Path directory)	Create a WorkingSet.Member.Kind.AGGREGATOR member.
Path	directory()	Returns the value of the directory record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isAggregator()	Whether this member is the workspace root (aggregator).
WorkingSet.Member.Kind	kind()	Returns the value of the kind record component.
String	name()	Returns the value of the name record component.
static WorkingSet.Member	subproject(String name, Path directory)	Create a WorkingSet.Member.Kind.SUBPROJECT member.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Member

public Member(String name,
 Path directory,
 WorkingSet.Member.Kind kind)

Creates an instance of a Member record class.

Parameters:

name - the value for the name record component

directory - the value for the directory record component

kind - the value for the kind record component

Method Details

subproject

public static WorkingSet.Member subproject(String name,
 Path directory)

Create a WorkingSet.Member.Kind.SUBPROJECT member.

Parameters:

name - the subproject name

directory - the subproject's git working tree

Returns:

a subproject member

aggregator

public static WorkingSet.Member aggregator(String name,
 Path directory)

Create a WorkingSet.Member.Kind.AGGREGATOR member.

Parameters:

name - the directory name of the workspace root (or single repository)

directory - the workspace root's git working tree

Returns:

an aggregator member

isAggregator

public boolean isAggregator()

Whether this member is the workspace root (aggregator).

Returns:

true if kind() is WorkingSet.Member.Kind.AGGREGATOR

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

directory

public Path directory()

Returns the value of the directory record component.

Returns:

the value of the directory record component

kind

public WorkingSet.Member.Kind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component