Class EmptyDocument

java.lang.Object
eu.cloudnetservice.driver.impl.document.empty.EmptyDocument
All Implemented Interfaces:
eu.cloudnetservice.driver.document.Document, eu.cloudnetservice.driver.document.Document.Mutable, eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder, eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder.Mutable<eu.cloudnetservice.driver.document.Document.Mutable>, eu.cloudnetservice.driver.document.property.DocPropertyHolder, eu.cloudnetservice.driver.document.property.DocPropertyHolder.Mutable<eu.cloudnetservice.driver.document.Document.Mutable>, Externalizable, Serializable
public final class EmptyDocument extends Object implements eu.cloudnetservice.driver.document.Document.Mutable, eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder.Mutable<eu.cloudnetservice.driver.document.Document.Mutable>
A document implementation that just ignores all calls made to it.
Since:
4.0
See Also:

  • Field Details

    • INSTANCE

      public static final eu.cloudnetservice.driver.document.Document.Mutable INSTANCE
      The jvm static instance of the empty document. There should never be a different instance of this class during the jvm lifetime.

      Note: do not use this field directly, prefer Document.emptyDocument() instead.

  • Constructor Details

    • EmptyDocument

      public EmptyDocument()
      Constructs an empty document instance. This constructor is public to all serialization of this document and should not be called. Obtain the singleton instance of this implementation via Document.emptyDocument().

  • Method Details

    • factoryName

      @NonNull public @NonNull String factoryName()
      Specified by:
      factoryName in interface eu.cloudnetservice.driver.document.Document

    • empty

      public boolean empty()
      Specified by:
      empty in interface eu.cloudnetservice.driver.document.Document

    • elementCount

      public int elementCount()
      Specified by:
      elementCount in interface eu.cloudnetservice.driver.document.Document

    • contains

      public boolean contains(@NonNull @NonNull String key)
      Specified by:
      contains in interface eu.cloudnetservice.driver.document.Document

    • containsNonNull

      public boolean containsNonNull(@NonNull @NonNull String key)
      Specified by:
      containsNonNull in interface eu.cloudnetservice.driver.document.Document

    • send

      @NonNull public @NonNull eu.cloudnetservice.driver.document.send.DocumentSend send()
      Specified by:
      send in interface eu.cloudnetservice.driver.document.Document

    • immutableCopy

      @NonNull public @NonNull eu.cloudnetservice.driver.document.Document immutableCopy()
      Specified by:
      immutableCopy in interface eu.cloudnetservice.driver.document.Document

    • mutableCopy

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable mutableCopy()
      Specified by:
      mutableCopy in interface eu.cloudnetservice.driver.document.Document

    • keys

      @NonNull public @Unmodifiable @NonNull Set<String> keys()
      Specified by:
      keys in interface eu.cloudnetservice.driver.document.Document

    • elements

      @NonNull public @Unmodifiable @NonNull Collection<? extends eu.cloudnetservice.driver.document.send.element.Element> elements()
      Specified by:
      elements in interface eu.cloudnetservice.driver.document.Document

    • toInstanceOf

      public <T> @UnknownNullability T toInstanceOf(@NonNull @NonNull Type type)
      Specified by:
      toInstanceOf in interface eu.cloudnetservice.driver.document.Document

    • toInstanceOf

      public <T> @UnknownNullability T toInstanceOf(@NonNull @NonNull Class<T> type)
      Specified by:
      toInstanceOf in interface eu.cloudnetservice.driver.document.Document

    • toInstanceOf

      public <T> @UnknownNullability T toInstanceOf(@NonNull @NonNull io.leangen.geantyref.TypeToken<T> type)
      Specified by:
      toInstanceOf in interface eu.cloudnetservice.driver.document.Document

    • readObject

      public <T> @UnknownNullability T readObject(@NonNull @NonNull String key, @NonNull @NonNull Type type, @Nullable T def)
      Specified by:
      readObject in interface eu.cloudnetservice.driver.document.Document

    • readObject

      public <T> @UnknownNullability T readObject(@NonNull @NonNull String key, @NonNull @NonNull Class<T> type, @Nullable T def)
      Specified by:
      readObject in interface eu.cloudnetservice.driver.document.Document

    • readObject

      public <T> @UnknownNullability T readObject(@NonNull @NonNull String key, @NonNull @NonNull io.leangen.geantyref.TypeToken<T> type, @Nullable T def)
      Specified by:
      readObject in interface eu.cloudnetservice.driver.document.Document

    • readDocument

      public @UnknownNullability eu.cloudnetservice.driver.document.Document readDocument(@NonNull @NonNull String key, @Nullable @Nullable eu.cloudnetservice.driver.document.Document def)
      Specified by:
      readDocument in interface eu.cloudnetservice.driver.document.Document

    • readMutableDocument

      public @UnknownNullability eu.cloudnetservice.driver.document.Document.Mutable readMutableDocument(@NonNull @NonNull String key, @Nullable eu.cloudnetservice.driver.document.Document.Mutable def)
      Specified by:
      readMutableDocument in interface eu.cloudnetservice.driver.document.Document

    • getByte

      public byte getByte(@NonNull @NonNull String key, byte def)
      Specified by:
      getByte in interface eu.cloudnetservice.driver.document.Document

    • getShort

      public short getShort(@NonNull @NonNull String key, short def)
      Specified by:
      getShort in interface eu.cloudnetservice.driver.document.Document

    • getInt

      public int getInt(@NonNull @NonNull String key, int def)
      Specified by:
      getInt in interface eu.cloudnetservice.driver.document.Document

    • getLong

      public long getLong(@NonNull @NonNull String key, long def)
      Specified by:
      getLong in interface eu.cloudnetservice.driver.document.Document

    • getFloat

      public float getFloat(@NonNull @NonNull String key, float def)
      Specified by:
      getFloat in interface eu.cloudnetservice.driver.document.Document

    • getDouble

      public double getDouble(@NonNull @NonNull String key, double def)
      Specified by:
      getDouble in interface eu.cloudnetservice.driver.document.Document

    • getBoolean

      public boolean getBoolean(@NonNull @NonNull String key, boolean def)
      Specified by:
      getBoolean in interface eu.cloudnetservice.driver.document.Document

    • getString

      public @UnknownNullability String getString(@NonNull @NonNull String key, @Nullable @Nullable String def)
      Specified by:
      getString in interface eu.cloudnetservice.driver.document.Document

    • writeTo

      public void writeTo(@NonNull @NonNull Path path, @NonNull @NonNull eu.cloudnetservice.driver.document.SerialisationStyle style)
      Specified by:
      writeTo in interface eu.cloudnetservice.driver.document.Document

    • writeTo

      public void writeTo(@NonNull @NonNull OutputStream stream, @NonNull @NonNull eu.cloudnetservice.driver.document.SerialisationStyle style)
      Specified by:
      writeTo in interface eu.cloudnetservice.driver.document.Document

    • writeTo

      public void writeTo(@NonNull @NonNull Appendable appendable, @NonNull @NonNull eu.cloudnetservice.driver.document.SerialisationStyle style)
      Specified by:
      writeTo in interface eu.cloudnetservice.driver.document.Document

    • writeTo

      public void writeTo(@NonNull eu.cloudnetservice.driver.network.buffer.DataBuf.Mutable dataBuf, @NonNull @NonNull eu.cloudnetservice.driver.document.SerialisationStyle style)
      Specified by:
      writeTo in interface eu.cloudnetservice.driver.document.Document

    • serializeToString

      @NonNull public @NonNull String serializeToString(@NonNull @NonNull eu.cloudnetservice.driver.document.SerialisationStyle style)
      Specified by:
      serializeToString in interface eu.cloudnetservice.driver.document.Document

    • clear

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable clear()
      Specified by:
      clear in interface eu.cloudnetservice.driver.document.Document.Mutable

    • remove

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable remove(@NonNull @NonNull String key)
      Specified by:
      remove in interface eu.cloudnetservice.driver.document.Document.Mutable

    • receive

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable receive(@NonNull @NonNull eu.cloudnetservice.driver.document.send.DocumentSend send)
      Specified by:
      receive in interface eu.cloudnetservice.driver.document.Document.Mutable

    • appendNull

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable appendNull(@NonNull @NonNull String key)
      Specified by:
      appendNull in interface eu.cloudnetservice.driver.document.Document.Mutable

    • appendTree

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable appendTree(@Nullable @Nullable Object value)
      Specified by:
      appendTree in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull eu.cloudnetservice.driver.document.Document document)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull String key, @Nullable @Nullable Object value)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull String key, @Nullable @Nullable Number value)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull String key, @Nullable @Nullable Boolean value)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull String key, @Nullable @Nullable String value)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • append

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable append(@NonNull @NonNull String key, @Nullable @Nullable eu.cloudnetservice.driver.document.Document value)
      Specified by:
      append in interface eu.cloudnetservice.driver.document.Document.Mutable

    • propertyHolder

      @NonNull public eu.cloudnetservice.driver.document.Document.Mutable propertyHolder()
      Specified by:
      propertyHolder in interface eu.cloudnetservice.driver.document.property.DocPropertyHolder
      Specified by:
      propertyHolder in interface eu.cloudnetservice.driver.document.property.DocPropertyHolder.Mutable<eu.cloudnetservice.driver.document.Document.Mutable>

    • equals

      public boolean equals(@Nullable @Nullable Object other)
      Specified by:
      equals in interface eu.cloudnetservice.driver.document.Document
      Overrides:
      equals in class Object

    • toString

      @NonNull public @NonNull String toString()
      Specified by:
      toString in interface eu.cloudnetservice.driver.document.Document
      Overrides:
      toString in class Object

    • writeExternal

      public void writeExternal(@NonNull @NonNull ObjectOutput out)
      Specified by:
      writeExternal in interface Externalizable

    • readExternal

      public void readExternal(@NonNull @NonNull ObjectInput in)
      Specified by:
      readExternal in interface Externalizable