com.hrznstudio.titanium.nbthandler.data

Class StringNBTHandler

java.lang.Object

com.hrznstudio.titanium.nbthandler.data.StringNBTHandler

All Implemented Interfaces:

INBTHandler<java.lang.String>

public class StringNBTHandler
extends java.lang.Object
implements INBTHandler<java.lang.String>

Constructor Summary

Constructors

Constructor and Description
StringNBTHandler()

Method Summary

Modifier and Type	Method and Description
boolean	isClassValid(java.lang.Class<?> aClass) Checks if the NBTHandler can handle a class.
java.lang.String	readFromNBT(net.minecraft.nbt.CompoundNBT compound, java.lang.String name, java.lang.String current) Reads the value from the NBT to be stored in the Field.
boolean	storeToNBT(net.minecraft.nbt.CompoundNBT compound, java.lang.String name, java.lang.String object) Stores a value as the given name in the NBT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StringNBTHandler

public StringNBTHandler()

Method Detail

isClassValid

public boolean isClassValid(java.lang.Class<?> aClass)

Description copied from interface: INBTHandler

Checks if the NBTHandler can handle a class.

Specified by:

isClassValid in interface INBTHandler<java.lang.String>

Parameters:

aClass - The class that wants to be checked.

Returns:

true if the capability can handle the class or false if it can't.

storeToNBT

public boolean storeToNBT(@Nonnull
                          net.minecraft.nbt.CompoundNBT compound,
                          @Nonnull
                          java.lang.String name,
                          @Nonnull
                          java.lang.String object)

Description copied from interface: INBTHandler

Stores a value as the given name in the NBT.

Specified by:

storeToNBT in interface INBTHandler<java.lang.String>

Parameters:

compound - The NBT where the object needs to be stored.

name - The name as it will be stored.

object - The object value to be stored.

Returns:

true if the Object was successfully stored in the NBT

readFromNBT

public java.lang.String readFromNBT(@Nonnull
                                    net.minecraft.nbt.CompoundNBT compound,
                                    @Nonnull
                                    java.lang.String name,
                                    @Nullable
                                    java.lang.String current)

Description copied from interface: INBTHandler

Reads the value from the NBT to be stored in the Field.

Specified by:

readFromNBT in interface INBTHandler<java.lang.String>

Parameters:

compound - The NBT that stores all the information.

name - The name of the object stored in the NBT.

current - The current value of the object

Returns:

The object if it was successfully stored or null if it wasn't giving the next handlers a chance to store the value.