java.lang.Object

cn.nukkit.blockproperty.BlockProperty<T>

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ArrayBlockProperty, BooleanBlockProperty, IntBlockProperty, UnsignedIntBlockProperty

@PowerNukkitOnly @Since("1.4.0.0-PN") @ParametersAreNonnullByDefault public abstract class BlockProperty<T extends Serializable> extends Object implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

BlockProperty(String name, boolean exportedToItem, int bitSize, String persistenceName)
Method Summary

Modifier and Type

Method

Description

abstract BlockProperty<T>

copy()

abstract BlockProperty<T>

exportingToItems(boolean exportedToItem)

int

getBitSize()

boolean

getDefaultBooleanValue()

int

getDefaultIntValue()

abstract T

getDefaultValue()

int

getIntValue(int currentMeta, int bitOffset)

int

getIntValue(long currentMeta, int bitOffset)

int

getIntValue(BigInteger currentMeta, int bitOffset)

abstract int

getIntValueForMeta(int meta)

abstract int

getMetaForPersistenceValue(String persistenceValue)

abstract int

getMetaForValue(T value)

final int

getMetaFromBigInt(BigInteger currentMeta, int bitOffset)

final int

getMetaFromInt(int currentMeta, int bitOffset)

final int

getMetaFromLong(long currentMeta, int bitOffset)

String

getName()

String

getPersistenceName()

String

getPersistenceValue(int currentMeta, int bitOffset)

String

getPersistenceValue(long currentMeta, int bitOffset)

String

getPersistenceValue(BigInteger currentMeta, int bitOffset)

abstract String

getPersistenceValueForMeta(int meta)

T

getValue(int currentMeta, int bitOffset)

T

getValue(long currentBigMeta, int bitOffset)

T

getValue(BigInteger currentHugeMeta, int bitOffset)

abstract Class<T>

getValueClass()

abstract T

getValueForMeta(int meta)

boolean

isDefaultBooleanValue(boolean value)

boolean

isDefaultIntValue(int value)

final boolean

isDefaultPersistentValue(String value)

abstract boolean

isDefaultValue(T value)

boolean

isExportedToItem()

int

setValue(int currentMeta, int bitOffset, T newValue)

long

setValue(long currentBigMeta, int bitOffset, T newValue)

BigInteger

setValue(BigInteger currentHugeMeta, int bitOffset, T newValue)

String

toString()

protected void

validateDirectly(T value)

final void

validateMeta(int meta, int offset)

final void

validateMeta(long meta, int offset)

final void

validateMeta(BigInteger meta, int offset)

protected abstract void

validateMetaDirectly(int meta)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- BlockProperty
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public BlockProperty(String name, boolean exportedToItem, int bitSize, String persistenceName)
  
  Throws:
  
  IllegalArgumentException - If the bit size is negative
Method Details
- setValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int setValue(int currentMeta, int bitOffset, @Nullable T newValue)
  
  Throws:
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
  
  InvalidBlockPropertyValueException - If the new value is not accepted by this property
- setValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public long setValue(long currentBigMeta, int bitOffset, @Nullable T newValue)
  
  Throws:
  
  InvalidBlockPropertyValueException - If the new value is not accepted by this property
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- setValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public BigInteger setValue(BigInteger currentHugeMeta, int bitOffset, @Nullable T newValue)
  
  Throws:
  
  InvalidBlockPropertyValueException - If the new value is not accepted by this property
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getMetaFromInt
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final int getMetaFromInt(int currentMeta, int bitOffset)
  
  Throws:
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getMetaFromLong
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final int getMetaFromLong(long currentMeta, int bitOffset)
  
  Throws:
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getMetaFromBigInt
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final int getMetaFromBigInt(BigInteger currentMeta, int bitOffset)
  
  Throws:
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public T getValue(int currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public T getValue(long currentBigMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public T getValue(BigInteger currentHugeMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getIntValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int getIntValue(int currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getIntValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int getIntValue(long currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getIntValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int getIntValue(BigInteger currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getPersistenceValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public String getPersistenceValue(int currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getPersistenceValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public String getPersistenceValue(long currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getPersistenceValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public String getPersistenceValue(BigInteger currentMeta, int bitOffset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getMetaForValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract int getMetaForValue(@Nullable T value)
  
  Throws:
  
  InvalidBlockPropertyValueException - If the value is invalid for this property
- getValueForMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public abstract T getValueForMeta(int meta)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
- getIntValueForMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract int getIntValueForMeta(int meta)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
- getPersistenceValueForMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract String getPersistenceValueForMeta(int meta)
  
  Throws:
  
  InvalidBlockPropertyMetaException - If the meta contains invalid data
- getMetaForPersistenceValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract int getMetaForPersistenceValue(String persistenceValue)
  
  Throws:
  
  InvalidBlockPropertyPersistenceValueException - IF the persistence value is not valid for this property
- validateDirectly
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") protected void validateDirectly(@Nullable T value)
  
  Throws:
  
  RuntimeException - Any runtime exception to indicate an invalid value
- validateMetaDirectly
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") protected abstract void validateMetaDirectly(int meta)
  
  Throws:
  
  RuntimeException - Any runtime exception to indicate an invalid meta
- validateMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final void validateMeta(int meta, int offset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - if the value in the meta at the given offset is not valid
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- validateMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final void validateMeta(long meta, int offset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - if the value in the meta at the given offset is not valid
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- validateMeta
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public final void validateMeta(BigInteger meta, int offset)
  
  Throws:
  
  InvalidBlockPropertyMetaException - if the value in the meta at the given offset is not valid
  
  IllegalArgumentException - If the offset is negative or would cause memory overflow
- getBitSize
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int getBitSize()
- getName
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public String getName()
- getPersistenceName
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public String getPersistenceName()
- getValueClass
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public abstract Class<T> getValueClass()
- isExportedToItem
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public boolean isExportedToItem()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- isDefaultValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract boolean isDefaultValue(@Nullable T value)
- isDefaultPersistentValue
  
  @PowerNukkitOnly @Since("1.5.2.0-PN") public final boolean isDefaultPersistentValue(@Nonnull String value)
- getDefaultValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") @Nonnull public abstract T getDefaultValue()
- isDefaultIntValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public boolean isDefaultIntValue(int value)
- isDefaultBooleanValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public boolean isDefaultBooleanValue(boolean value)
- getDefaultIntValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public int getDefaultIntValue()
- getDefaultBooleanValue
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public boolean getDefaultBooleanValue()
- copy
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract BlockProperty<T> copy()
- exportingToItems
  
  @PowerNukkitOnly @Since("1.4.0.0-PN") public abstract BlockProperty<T> exportingToItems(boolean exportedToItem)

Class BlockProperty<T extends Serializable>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

BlockProperty

Method Details

setValue

setValue

setValue

getMetaFromInt

getMetaFromLong

getMetaFromBigInt

getValue

getValue

getValue

getIntValue

getIntValue

getIntValue

getPersistenceValue

getPersistenceValue

getPersistenceValue

getMetaForValue

getValueForMeta

getIntValueForMeta

getPersistenceValueForMeta

getMetaForPersistenceValue

validateDirectly

validateMetaDirectly

validateMeta

validateMeta

validateMeta

getBitSize

getName

getPersistenceName

getValueClass

isExportedToItem

toString

isDefaultValue

isDefaultPersistentValue

getDefaultValue

isDefaultIntValue

isDefaultBooleanValue

getDefaultIntValue

getDefaultBooleanValue

copy

exportingToItems