Uses of Interface
eu.cloudnetservice.driver.document.property.DocProperty

Packages that use DocProperty

Package	Description
eu.cloudnetservice.driver.channel
eu.cloudnetservice.driver.document.property
eu.cloudnetservice.driver.service

Uses of DocProperty in eu.cloudnetservice.driver.channel

Methods in eu.cloudnetservice.driver.channel with parameters of type DocProperty

Modifier and Type	Method	Description
static @NonNull ChannelMessageTarget	ChannelMessageTarget.servicesWithProperty(@NonNull DocProperty<?> property)	Get a channel message target that targets all services that have the given property associated with any value.

Uses of DocProperty in eu.cloudnetservice.driver.document.property

Classes in eu.cloudnetservice.driver.document.property that implement DocProperty

Modifier and Type	Class	Description
(package private) final record	DefaultingDocProperty<E>	A doc property that injects the given default value when reading or writing a null value.
(package private) final record	ReadOnlyDocProperty<E>	A doc property implementation that only allows reading the value from a document but not setting the value.
(package private) final record	RewritingDocProperty<I,O>	A doc property implementation that calls the given functions when reading/writing the value from a document to convert it into a different value (for example when parsing).
(package private) final record	StandardDocProperty<E>	The standard implementation of a doc property that does no special processing of the read/written values and supports read and write operations from/to the given document.

Fields in eu.cloudnetservice.driver.document.property declared as DocProperty

Modifier and Type	Field	Description
private final @NonNull DocProperty<E>	DefaultingDocProperty.downstream	The field for the downstream record component.
private final @NonNull DocProperty<E>	ReadOnlyDocProperty.downstream	The field for the downstream record component.
private final @NonNull DocProperty<I>	RewritingDocProperty.upstream	The field for the upstream record component.

Methods in eu.cloudnetservice.driver.document.property that return DocProperty

Modifier and Type	Method	Description
@NonNull DocProperty<E>	DefaultingDocProperty.asReadOnly()	Wraps this property in a new property that makes any write operation with this property throw an exception.
@NonNull DocProperty<E>	DocProperty.asReadOnly()	Wraps this property in a new property that makes any write operation with this property throw an exception.
@NonNull DocProperty<E>	ReadOnlyDocProperty.asReadOnly()	Wraps this property in a new property that makes any write operation with this property throw an exception.
@NonNull DocProperty<O>	RewritingDocProperty.asReadOnly()	Wraps this property in a new property that makes any write operation with this property throw an exception.
@NonNull DocProperty<E>	StandardDocProperty.asReadOnly()	Wraps this property in a new property that makes any write operation with this property throw an exception.
@NonNull DocProperty<E>	DefaultingDocProperty.downstream()	Returns the value of the downstream record component.
@NonNull DocProperty<E>	ReadOnlyDocProperty.downstream()	Returns the value of the downstream record component.
static <E> @NonNull DocProperty<E>	DocProperty.genericProperty(@NonNull String key, @NonNull Type type)	Creates a new property that reads and writes values of the given type from/into a document using the given key.
static <E> @NonNull DocProperty<E>	DocProperty.property(@NonNull String key, @NonNull Class<E> type)	Creates a new property that reads and writes values of the given type from/into a document using the given key.
@NonNull DocProperty<I>	RewritingDocProperty.upstream()	Returns the value of the upstream record component.
@NonNull DocProperty<E>	DefaultingDocProperty.withDefault(E def)	Wraps this property to make read and write operations set a default value in case the given value is either absent (not appended to the document) or set to null.
@NonNull DocProperty<E>	DocProperty.withDefault(E def)	Wraps this property to make read and write operations set a default value in case the given value is either absent (not appended to the document) or set to null.
@NonNull DocProperty<E>	ReadOnlyDocProperty.withDefault(E def)	Wraps this property to make read and write operations set a default value in case the given value is either absent (not appended to the document) or set to null.
@NonNull DocProperty<O>	RewritingDocProperty.withDefault(O def)	Wraps this property to make read and write operations set a default value in case the given value is either absent (not appended to the document) or set to null.
@NonNull DocProperty<E>	StandardDocProperty.withDefault(E def)	Wraps this property to make read and write operations set a default value in case the given value is either absent (not appended to the document) or set to null.
<V> @NonNull DocProperty<V>	DefaultingDocProperty.withReadRewrite(@NonNull Function<E,V> rewriteFunction)	Wraps this property to apply a rewrite function when reading the property from a document.
<V> @NonNull DocProperty<V>	DocProperty.withReadRewrite(@NonNull Function<E,V> rewriteFunction)	Wraps this property to apply a rewrite function when reading the property from a document.
<V> @NonNull DocProperty<V>	ReadOnlyDocProperty.withReadRewrite(@NonNull Function<E,V> rewriteFunction)	Wraps this property to apply a rewrite function when reading the property from a document.
<V> @NonNull DocProperty<V>	RewritingDocProperty.withReadRewrite(@NonNull Function<O,V> rewriteFunction)	Wraps this property to apply a rewrite function when reading the property from a document.
<V> @NonNull DocProperty<V>	StandardDocProperty.withReadRewrite(@NonNull Function<E,V> rewriteFunction)	Wraps this property to apply a rewrite function when reading the property from a document.
<V> @NonNull DocProperty<V>	DefaultingDocProperty.withReadWriteRewrite(@NonNull Function<E,V> readRewriteFunction, @Nullable Function<V,E> writeRewriteFunction)	Wraps this property to apply a rewrite function when reading and writing the property from/to a document.
<V> @NonNull DocProperty<V>	DocProperty.withReadWriteRewrite(@NonNull Function<E,V> readRewriteFunction, @Nullable Function<V,E> writeRewriteFunction)	Wraps this property to apply a rewrite function when reading and writing the property from/to a document.
<V> @NonNull DocProperty<V>	ReadOnlyDocProperty.withReadWriteRewrite(@NonNull Function<E,V> readRewriteFunction, @Nullable Function<V,E> writeRewriteFunction)	Wraps this property to apply a rewrite function when reading and writing the property from/to a document.
<V> @NonNull DocProperty<V>	RewritingDocProperty.withReadWriteRewrite(@NonNull Function<O,V> readRewriteFunction, @Nullable Function<V,O> writeRewriteFunction)	Wraps this property to apply a rewrite function when reading and writing the property from/to a document.
<V> @NonNull DocProperty<V>	StandardDocProperty.withReadWriteRewrite(@NonNull Function<E,V> readRewriteFunction, @Nullable Function<V,E> writeRewriteFunction)	Wraps this property to apply a rewrite function when reading and writing the property from/to a document.
@NonNull DocProperty<E>	DefaultingDocProperty.writeTo(Document.Mutable document, E value)	Writes the given value into the given document.
@NonNull DocProperty<E>	DocProperty.writeTo(Document.Mutable document, E value)	Writes the given value into the given document.
@NonNull DocProperty<E>	ReadOnlyDocProperty.writeTo(Document.Mutable document, E value)	Writes the given value into the given document.
@NonNull DocProperty<O>	RewritingDocProperty.writeTo(Document.Mutable document, O value)	Writes the given value into the given document.
@NonNull DocProperty<E>	StandardDocProperty.writeTo(Document.Mutable document, E value)	Writes the given value into the given document.

Methods in eu.cloudnetservice.driver.document.property with parameters of type DocProperty

Modifier and Type	Method	Description
default <E> boolean	DefaultedDocPropertyHolder.propertyAbsent(@NonNull DocProperty<E> property)	Get if no value is associated with the given property.
<E> boolean	DocPropertyHolder.propertyAbsent(@NonNull DocProperty<E> property)	Get if no value is associated with the given property.
default <E> boolean	DefaultedDocPropertyHolder.propertyPresent(@NonNull DocProperty<E> property)	Get if a value is associated with the given property.
<E> boolean	DocPropertyHolder.propertyPresent(@NonNull DocProperty<E> property)	Get if a value is associated with the given property.
default <E> @UnknownNullability E	DefaultedDocPropertyHolder.readProperty(@NonNull DocProperty<E> property)	Reads the value of the given property from the underlying document.
<E> @UnknownNullability E	DocPropertyHolder.readProperty(@NonNull DocProperty<E> property)	Reads the value of the given property from the underlying document.
default <E> @UnknownNullability E	DefaultedDocPropertyHolder.readPropertyOrDefault(@NonNull DocProperty<E> property, E def)	Reads the given property from the underlying document or returns the given default value if the property is not set or set to null.
<E> @UnknownNullability E	DocPropertyHolder.readPropertyOrDefault(@NonNull DocProperty<E> property, E def)	Reads the given property from the underlying document or returns the given default value if the property is not set or set to null.
default <E> @UnknownNullability E	DefaultedDocPropertyHolder.readPropertyOrGet(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> supplier)	Reads the given property from the underlying document or returns the default value computed by the given supplier if the property is not set or set to null.
<E> @UnknownNullability E	DocPropertyHolder.readPropertyOrGet(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> supplier)	Reads the given property from the underlying document or returns the default value computed by the given supplier if the property is not set or set to null.
default <E> E	DefaultedDocPropertyHolder.readPropertyOrThrow(@NonNull DocProperty<E> property)	Reads the given property from the underlying document or throws a NoSuchElementException if the value is not set or set to null.
default <E, T extends Throwable> E	DefaultedDocPropertyHolder.readPropertyOrThrow(@NonNull DocProperty<E> property, @NonNull Supplier<? extends T> exceptionSupplier)	Reads the given property from the underlying document or throws the exception that is computed by the given exception supplier if the value is not set or set to null.
<E> E	DocPropertyHolder.readPropertyOrThrow(@NonNull DocProperty<E> property)	Reads the given property from the underlying document or throws a NoSuchElementException if the value is not set or set to null.
<E, T extends Throwable> E	DocPropertyHolder.readPropertyOrThrow(@NonNull DocProperty<E> property, @NonNull Supplier<? extends T> exceptionSupplier)	Reads the given property from the underlying document or throws the exception that is computed by the given exception supplier if the value is not set or set to null.
default <E> E	DefaultedDocPropertyHolder.Mutable.removeProperty(@NonNull DocProperty<E> property)	Removes the given doc property from the underlying document.
<E> @UnknownNullability E	DocPropertyHolder.Mutable.removeProperty(@NonNull DocProperty<E> property)	Removes the given doc property from the underlying document.
default <E> S	DefaultedDocPropertyHolder.Mutable.writeProperty(@NonNull DocProperty<E> property, E value)	Writes the given property and value into the underlying document.
<E> S	DocPropertyHolder.Mutable.writeProperty(@NonNull DocProperty<E> property, E value)	Writes the given property and value into the underlying document.
default <E> S	DefaultedDocPropertyHolder.Mutable.writePropertyIfAbsent(@NonNull DocProperty<E> property, E value)	Writes the given property and value into the underlying document if no other value is associated yet with the given property.
default <E> S	DefaultedDocPropertyHolder.Mutable.writePropertyIfAbsent(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> valueSupplier)	Writes the given property and computed value into the underlying document if no other value is associated yet with the given property.
<E> S	DocPropertyHolder.Mutable.writePropertyIfAbsent(@NonNull DocProperty<E> property, E value)	Writes the given property and value into the underlying document if no other value is associated yet with the given property.
<E> S	DocPropertyHolder.Mutable.writePropertyIfAbsent(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> valueSupplier)	Writes the given property and computed value into the underlying document if no other value is associated yet with the given property.
default <E> S	DefaultedDocPropertyHolder.Mutable.writePropertyIfPresent(@NonNull DocProperty<E> property, E val)	Writes the given property and value into the underlying document if another value is already associated with the given property.
default <E> S	DefaultedDocPropertyHolder.Mutable.writePropertyIfPresent(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> valueSupplier)	Writes the given property and computed value into the underlying document if another value is already associated with the given property.
<E> S	DocPropertyHolder.Mutable.writePropertyIfPresent(@NonNull DocProperty<E> property, E value)	Writes the given property and value into the underlying document if another value is already associated with the given property.
<E> S	DocPropertyHolder.Mutable.writePropertyIfPresent(@NonNull DocProperty<E> property, @NonNull Supplier<? extends E> valueSupplier)	Writes the given property and computed value into the underlying document if another value is already associated with the given property.

Constructors in eu.cloudnetservice.driver.document.property with parameters of type DocProperty

Modifier	Constructor	Description
(package private)	DefaultingDocProperty(@NonNull DocProperty<E> downstream, E def)	Creates an instance of a DefaultingDocProperty record class.
(package private)	ReadOnlyDocProperty(@NonNull DocProperty<E> downstream)	Creates an instance of a ReadOnlyDocProperty record class.
(package private)	RewritingDocProperty(@NonNull DocProperty<I> upstream, @NonNull Function<I,O> readRewriteFunction, @Nullable Function<O,I> writeRewriteFunction)	Creates an instance of a RewritingDocProperty record class.

Uses of DocProperty in eu.cloudnetservice.driver.service

Fields in eu.cloudnetservice.driver.service declared as DocProperty

Modifier and Type	Field	Description
static final DocProperty<Map<String,String>>	ServiceRemoteInclusion.HEADERS	A property which can be added to a service inclusion to set the http headers to send when making the download http request.
static final DocProperty<Boolean>	ServiceEnvironmentType.JAVA_PROXY	A property set on all service environment types which are a Minecraft java edition proxy.
static final DocProperty<Boolean>	ServiceEnvironmentType.JAVA_SERVER	A property set on all service environment types which are a Minecraft java edition server.
static final DocProperty<Boolean>	ServiceEnvironmentType.PE_PROXY	A property set on all service environment types which are a Minecraft pocket edition proxy.
static final DocProperty<Boolean>	ServiceEnvironmentType.PE_SERVER	A property set on all service environment types which are a Minecraft pocket edition server.
static final DocProperty<String>	ServiceEnvironmentType.PLUGIN_DIR	A property which defines the plugin directory of a service environment.