Record Class ParsedArguments

java.lang.Object

java.lang.Record

me.pauleff.common.argparse.ParsedArguments

Record Components:

serverPath - the path to the server folder, if specified

toOnlineMode - true for online conversion, false for offline, or empty when no conversion was requested

copyPlayerDataSourceWorld - the source world folder name to copy player data from, if requested

serverPropertiesChanges - key/value pairs to apply to server.properties; may be empty

public record ParsedArguments(Optional<Path> serverPath, Optional<Boolean> toOnlineMode, Optional<String> copyPlayerDataSourceWorld, Map<String,String> serverPropertiesChanges)
extends Record

Holds the successfully parsed CLI options that drive conversion and related operations.

Constructor Summary

Constructors

Constructor	Description
ParsedArguments(Optional<Path> serverPath, Optional<Boolean> toOnlineMode, Optional<String> copyPlayerDataSourceWorld, Map<String,String> serverPropertiesChanges)	Creates an instance of a ParsedArguments record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	copyPlayerDataSourceWorld()	Returns the value of the copyPlayerDataSourceWorld 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	isConversionOperation()	Indicates whether an online/offline conversion was requested.
Optional<Path>	serverPath()	Returns the value of the serverPath record component.
Map<String,String>	serverPropertiesChanges()	Returns the value of the serverPropertiesChanges record component.
boolean	shouldCopyPlayerData()	Indicates whether player data should be copied from another world.
Optional<Boolean>	toOnlineMode()	Returns the value of the toOnlineMode 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

ParsedArguments

public ParsedArguments(Optional<Path> serverPath,
 Optional<Boolean> toOnlineMode,
 Optional<String> copyPlayerDataSourceWorld,
 Map<String,String> serverPropertiesChanges)

Creates an instance of a ParsedArguments record class.

Parameters:

serverPath - the value for the serverPath record component

toOnlineMode - the value for the toOnlineMode record component

copyPlayerDataSourceWorld - the value for the copyPlayerDataSourceWorld record component

serverPropertiesChanges - the value for the serverPropertiesChanges record component

Method Details

isConversionOperation

public boolean isConversionOperation()

Indicates whether an online/offline conversion was requested.

Returns:

true if toOnlineMode is present; false otherwise

shouldCopyPlayerData

public boolean shouldCopyPlayerData()

Indicates whether player data should be copied from another world.

Returns:

true if copyPlayerDataSourceWorld is present; false otherwise

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.

serverPath

public Optional<Path> serverPath()

Returns the value of the serverPath record component.

Returns:

the value of the serverPath record component

toOnlineMode

public Optional<Boolean> toOnlineMode()

Returns the value of the toOnlineMode record component.

Returns:

the value of the toOnlineMode record component

copyPlayerDataSourceWorld

public Optional<String> copyPlayerDataSourceWorld()

Returns the value of the copyPlayerDataSourceWorld record component.

Returns:

the value of the copyPlayerDataSourceWorld record component

serverPropertiesChanges

public Map<String,String> serverPropertiesChanges()

Returns the value of the serverPropertiesChanges record component.

Returns:

the value of the serverPropertiesChanges record component