Refactor some Type names and javadocs

This commit is contained in:
nossr50 2019-10-30 14:56:30 -07:00
parent fdb900ec5d
commit 9911c406f8
4 changed files with 79 additions and 6 deletions

View File

@ -3,5 +3,11 @@ package com.gmail.nossr50.core.adapters;
import com.gmail.nossr50.core.nbt.NBTBase; import com.gmail.nossr50.core.nbt.NBTBase;
public interface NBTAdapter { public interface NBTAdapter {
/**
* Transform our NBT type representation to its implementation on the target platform
* @param nbtBase target NBT type representation
* @return platform specific implementation of our NBT Type
*/
Object asNative(NBTBase nbtBase); Object asNative(NBTBase nbtBase);
} }

View File

@ -18,7 +18,7 @@ public class BukkitNBTAdapter implements NBTAdapter {
case SHORT: case SHORT:
return asNativeNBTShort((NBTShort) nbtBase); return asNativeNBTShort((NBTShort) nbtBase);
case INT: case INT:
return asNativeNBTInt((NBTInteger) nbtBase); return asNativeNBTInt((NBTInt) nbtBase);
case LONG: case LONG:
return asNativeNBTLong((NBTLong) nbtBase); return asNativeNBTLong((NBTLong) nbtBase);
case FLOAT: case FLOAT:
@ -34,9 +34,9 @@ public class BukkitNBTAdapter implements NBTAdapter {
case COMPOUND: case COMPOUND:
return ; return ;
case INT_ARRAY: case INT_ARRAY:
break; return asNativeNBTIntArray((NBTIntArray) nbtBase);
case LONG_ARRAY: case LONG_ARRAY:
break; return asNativeNBTLongArray((NBTLongArray) nbtBase);
} }
return null; return null;
@ -51,42 +51,105 @@ public class BukkitNBTAdapter implements NBTAdapter {
return new NBTTagByte(nbtByte.getValue()); return new NBTTagByte(nbtByte.getValue());
} }
/**
* Create a NBTTagShort (NMS Type) from our NBTShort representation
* @param nbtShort target NBTShort
* @return NBTTagShort copy of our NBTShort representation
*/
private NBTTagShort asNativeNBTShort(NBTShort nbtShort) { private NBTTagShort asNativeNBTShort(NBTShort nbtShort) {
return new NBTTagShort(nbtShort.getValue()); return new NBTTagShort(nbtShort.getValue());
} }
private NBTTagInt asNativeNBTInt(NBTInteger nbtInteger) { /**
return new NBTTagInt(nbtInteger.getValue()); * Create a NBTTagInt (NMS Type) from our NBTInt representation
* @param nbtInt target NBTInt
* @return NBTTagInt copy of our NBTInt representation
*/
private NBTTagInt asNativeNBTInt(NBTInt nbtInt) {
return new NBTTagInt(nbtInt.getValue());
} }
/**
* Create a NBTTagLong (NMS Type) from our NBTLong representation
* @param nbtLong target NBTLong
* @return NBTTagLong copy of our NBTLong representation
*/
private NBTTagLong asNativeNBTLong(NBTLong nbtLong) { private NBTTagLong asNativeNBTLong(NBTLong nbtLong) {
return new NBTTagLong(nbtLong.getValue()); return new NBTTagLong(nbtLong.getValue());
} }
/**
* Create a NBTTagFloat (NMS Type) from our NBTFloat representation
* @param nbtFloat target NBTFloat
* @return NBTTagFloat copy of our NBTFloat representation
*/
private NBTTagFloat asNativeNBTFloat(NBTFloat nbtFloat) { private NBTTagFloat asNativeNBTFloat(NBTFloat nbtFloat) {
return new NBTTagFloat(nbtFloat.getValue()); return new NBTTagFloat(nbtFloat.getValue());
} }
/**
* Create a NBTTagDouble (NMS Type) from our NBTDouble representation
* @param nbtDouble target NBTDouble
* @return NBTTagDouble copy of our NBTDouble representation
*/
private NBTTagDouble asNativeNBTDouble(NBTDouble nbtDouble) { private NBTTagDouble asNativeNBTDouble(NBTDouble nbtDouble) {
return new NBTTagDouble(nbtDouble.getValue()); return new NBTTagDouble(nbtDouble.getValue());
} }
/**
* Create a NBTTagByteArray (NMS Type) from our NBTByteArray representation
* @param nbtByteArray target NBTByteArray
* @return NBTTagByteArray copy of our NBTByteArray representation
*/
private NBTTagByteArray asNativeNBTByteArray(NBTByteArray nbtByteArray) { private NBTTagByteArray asNativeNBTByteArray(NBTByteArray nbtByteArray) {
return new NBTTagByteArray(nbtByteArray.getValues()); return new NBTTagByteArray(nbtByteArray.getValues());
} }
/**
* Create a NBTTagString (NMS Type) from our NBTString representation
* @param nbtString target NBTString
* @return NBTTagString copy of our NBTString representation
*/
private NBTTagString asNativeNBTString(NBTString nbtString) { private NBTTagString asNativeNBTString(NBTString nbtString) {
return new NBTTagString(nbtString.getValue()); return new NBTTagString(nbtString.getValue());
} }
/**
* Create a NBTTagList (NMS Type) from our NBTList representation
* @param nbtList target NBTList
* @return NBTTagList copy of our NBTList representation
*/
private NBTTagList asNativeNBTList(NBTList nbtList) { private NBTTagList asNativeNBTList(NBTList nbtList) {
NBTTagList nbtTagList = new NBTTagList(); NBTTagList nbtTagList = new NBTTagList();
nbtList.setValues(nbtList.getValues()); nbtList.setValues(nbtList.getValues());
return nbtTagList; return nbtTagList;
} }
/**
* Create a NBTTagCompound (NMS Type) from our NBTCompound representation
* @param nbtCompound target NBTCompound
* @return NBTTagCompound copy of our NBTCompound representation
*/
private NBTTagCompound asNativeNBTCompound(NBTCompound nbtCompound) { private NBTTagCompound asNativeNBTCompound(NBTCompound nbtCompound) {
NBTTagCompound nbtTagCompound = new NBTTagCompound(); NBTTagCompound nbtTagCompound = new NBTTagCompound();
nbtCompound nbtCompound
} }
/**
* Create a NBTTagIntArray (NMS Type) from our NBTIntArray representation
* @param nbtIntArray target NBTIntArray
* @return NBTTagIntArray copy of our NBTIntArray representation
*/
private NBTTagIntArray asNativeNBTIntArray(NBTIntArray nbtIntArray) {
return new NBTTagIntArray(nbtIntArray.getValues());
}
/**
* Create a NBTTagLongArray (NMS Type) from our NBTLongArray representation
* @param nbtLongArray target NBTLongArray
* @return NBTTagLongArray copy of our NBTLongArray representation
*/
private NBTTagLongArray asNativeNBTLongArray(NBTLongArray nbtLongArray) {
return new NBTTagLongArray(nbtLongArray.getValues());
}
} }

View File

@ -8,6 +8,10 @@ public abstract class PlatformAdapter {
this.nbtAdapter = nbtAdapter; this.nbtAdapter = nbtAdapter;
} }
/**
* Get the NBT Adapter for this platform
* @return the platform's NBT adapter
*/
public NBTAdapter getNbtAdapter() { public NBTAdapter getNbtAdapter() {
return nbtAdapter; return nbtAdapter;
} }

View File

@ -1,6 +1,6 @@
package com.gmail.nossr50.core.nbt; package com.gmail.nossr50.core.nbt;
public class NBTInteger implements NBTBase { public class NBTInt implements NBTBase {
private String key; private String key;
private int value; private int value;