Package space.arim.dazzleconf.backend

Class KeyPath.Immut

java.lang.Object

space.arim.dazzleconf.backend.KeyPath

space.arim.dazzleconf.backend.KeyPath.Immut

All Implemented Interfaces:

Printable

Enclosing class:

KeyPath

public static final class KeyPath.Immut
extends KeyPath

A key path which is unmistakably immutable.

Nested Class Summary

Nested classes/interfaces inherited from class space.arim.dazzleconf.backend.KeyPath

KeyPath.Immut, KeyPath.Mut, KeyPath.SequenceBoundary

Nested classes/interfaces inherited from interface space.arim.dazzleconf.backend.Printable

Printable.Abstract

Constructor Summary

Constructors

Constructor	Description
Immut()	Creates an empty key path
Immut(@NonNull String @NonNull ... parts)	Creates from the given parts
Immut(@NonNull KeyPath other)	Creates from another key path.

Method Summary

Modifier and Type	Method	Description
@NonNull KeyPath.Immut	intoImmut()	Gets this key path as an immutable one.
@NonNull KeyPath.Mut	intoMut()	Gets this key path as a mutable one.

Methods inherited from class space.arim.dazzleconf.backend.KeyPath

empty, equals, forEach, getLeading, hashCode, intoParts, intoPartsList, isEmpty, iterateFrom, printString, printTo, printTo, size, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Immut

public Immut()

Creates an empty key path

Immut

public Immut(@NonNull String @NonNull ... parts)

Creates from the given parts

Parameters:

parts - the parts

Immut

public Immut(@NonNull KeyPath other)

Creates from another key path.

This will copy the parts of that key path into this one.

Parameters:

other - the other key path

Method Details

intoMut

public @NonNull KeyPath.Mut intoMut()

Description copied from class: KeyPath

Gets this key path as a mutable one.

If not mutable, the data is copied to a new key path which is returned. This copying may be performed lazily, such as by deferring to the first mutative operation on the returned object.

Specified by:

intoMut in class KeyPath

Returns:

this key path if mutable, or a mutable copy if needed

intoImmut

public @NonNull KeyPath.Immut intoImmut()

Description copied from class: KeyPath

Gets this key path as an immutable one.

The data contained within this KeyPath is moved to an immutable instance. The old instance may still be used, but the implementation of this method may be optimized for the case that it is not.

If this instance is already DataTree.Immut, then it may be returned without changes.

Specified by:

intoImmut in class KeyPath

Returns:

an immutable key path