Record Class PlantUmlComponent

java.lang.Object

java.lang.Record

dev.archunitjava.diagram.plantuml.PlantUmlComponent

All Implemented Interfaces:

Comparable<PlantUmlComponent>

public record PlantUmlComponent(String displayName, String alias, Optional<String> stereotype)
extends Record
implements Comparable<PlantUmlComponent>

One safely parsed component with a unique alias and display name.

Constructor Summary

Constructors

Constructor	Description
PlantUmlComponent(String displayName, String alias, Optional<String> stereotype)	Creates an instance of a PlantUmlComponent record class.

Method Summary

Modifier and Type	Method	Description
String	alias()	Returns the value of the alias record component.
int	compareTo(PlantUmlComponent other)
String	displayName()	Returns the value of the displayName 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.
Optional<String>	stereotype()	Returns the value of the stereotype record component.
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

PlantUmlComponent

public PlantUmlComponent(String displayName,
 String alias,
 Optional<String> stereotype)

Creates an instance of a PlantUmlComponent record class.

Parameters:

displayName - the value for the displayName record component

alias - the value for the alias record component

stereotype - the value for the stereotype record component

Method Details

compareTo

public int compareTo(PlantUmlComponent other)

Specified by:

compareTo in interface Comparable<PlantUmlComponent>

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.

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

alias

public String alias()

Returns the value of the alias record component.

Returns:

the value of the alias record component

stereotype

public Optional<String> stereotype()

Returns the value of the stereotype record component.

Returns:

the value of the stereotype record component