Refactoring VariableConverter, splitting it to VariableParser and it.

Some formatings

Author: SimplyProgrammer

SerialX-core/src/main/java/org/ugp/serialx/GenericScope.java

@@ -267,7 +267,7 @@ public <V extends ValT> V get(KeyT variableKey)
 	 * @param variableKey | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Value of variable with name or defaultValue if there is no such a one!
+	 * @return Value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * 
 	 * @since 1.2.5
 	 */
@@ -337,7 +337,7 @@ public <V extends ValT> V get(KeyT... pathToValue)
 	 * @param cls | Default value to return.
 	 * @param defaultValue | Class that you want the obtained object to be converted into! Exact conversion algorithm can differ based on its implementations.
 	 * 
-	 * @return Value of variable with name given converted to object of cls or defaultValue if there is no such a one!
+	 * @return Value of variable with name given converted to object of cls or defaultValue if there is no such a one or given key contains null!
 	 * 
 	 * @throws Exception | If converting to object of cls failed from some reason! This can differ from implementation to implementation! By default it uses {@link GenericScope#toObject(cls)}
 	 * 
@@ -792,7 +792,7 @@ public boolean isEmpty()
 	 */
 	public <T extends GenericScope<?, ?>> T getParent()
 	{
-		return (T) getParent(1);	
+		return getParent(1);	
 	}
 
 	/**
@@ -804,6 +804,7 @@ public boolean isEmpty()
 	 * 
 	 * @since 1.3.2
 	 */
+	@SuppressWarnings("unchecked")
 	public <T extends GenericScope<?, ?>> T getParent(int depth)
 	{
 		if (depth < 1)

SerialX-core/src/main/java/org/ugp/serialx/Scope.java

@@ -159,7 +159,7 @@ public byte getByte(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Byte value of variable with name or defaultValue if there is no such a one!
+	 * @return Byte value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Byte will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -186,7 +186,7 @@ public short getShort(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Byte value of variable with name or defaultValue if there is no such a one!
+	 * @return Byte value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Byte will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -213,7 +213,7 @@ public int getInt(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Int value of variable with name or defaultValue if there is no such a one!
+	 * @return Int value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Int will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -240,7 +240,7 @@ public int getLong(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Long value of variable with name or defaultValue if there is no such a one!
+	 * @return Long value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Long will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -267,7 +267,7 @@ public float getFloat(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Float value of variable with name or defaultValue if there is no such a one!
+	 * @return Float value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Float will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -294,7 +294,7 @@ public double getDouble(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Double value of variable with name or defaultValue if there is no such a one!
+	 * @return Double value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Double will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -328,7 +328,7 @@ public String getString(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return String value of variable with name or defaultValue if there is no such a one!
+	 * @return String value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * String will be also parsed from any object using {@link Object#toString()}!
 	 * 
 	 * @since 1.2.5
@@ -355,7 +355,7 @@ public char getChar(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Char value of variable with name or defaultValue if there is no such a one!
+	 * @return Char value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Char will be also parsed from {@link Number}, {@link Character} or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -389,7 +389,7 @@ public boolean getBool(String variableName)
 	 * @param variableName | Variables name.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Boolean value of variable with name or defaultValue if there is no such a one!
+	 * @return Boolean value of variable with name or defaultValue if there is no such a one or given key contains null!
 	 * Boolean will be also parsed from {@link Number}, or {@link CharSequence} if possible!
 	 * 
 	 * @since 1.2.5
@@ -715,7 +715,7 @@ public <T> T toObjectOf(String variableWithscope, Class<T> objClass) throws Exce
 	 * @param objClass | Object of class to create.
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Value of variable with name or defaultValue if there is no such a one! If there is no Scope<Object, ?> stored by variableWithScope this function behaves same as {@link Scope#get(String, Object)}!
+	 * @return Value of variable with name or defaultValue if there is no such a one or given key contains null! If there is no Scope<Object, ?> stored by variableWithScope this function behaves same as {@link Scope#get(String, Object)}!
 	 * If variableWithScope contains {@link GenericScope} like it supposed to, then values of scope are parsed to {@link SerializationProtocol} of objClass.
 	 * 
 	 * @see Serializer#PROTOCOL_REGISTRY
@@ -736,7 +736,7 @@ public <T> T toObjectOf(String variableWithscope, Class<T> objClass, T defaultVa
 	 * @param defaultValue | Default value to return.
 	 * @param protocolsToUse | Registry of protocols to use.
 	 * 
-	 * @return Value of variable with name or defaultValue if there is no such a one! If there is no Scope<Object, ?> stored by variableWithScope this function behaves same as {@link Scope#get(String, Object)}!
+	 * @return Value of variable with name or defaultValue if there is no such a one or given key contains null! If there is no Scope<Object, ?> stored by variableWithScope this function behaves same as {@link Scope#get(String, Object)}!
 	 * If variableWithScope contains {@link GenericScope} like it supposed to, then values of scope are parsed to {@link SerializationProtocol} of objClass.
 	 * 
 	 * @see Serializer#PROTOCOL_REGISTRY

SerialX-core/src/main/java/org/ugp/serialx/Utils.java

@@ -854,6 +854,8 @@ public static void post(Serializer serializer, HttpURLConnection conn) throws IO
 	 * @author PETO
 	 *
 	 * @since 1.2.2
+	 * 
+	 * @deprecated (in 1.3.7) NO LONGER NEEDED, DO NOT USE THIS! You were never supposed to...
 	 */
 	public static final class NULL //TODO: REMOVE!!!!
 	{

SerialX-core/src/main/java/org/ugp/serialx/converters/DataParser.java

@@ -41,7 +41,7 @@ public interface DataParser
 	 * 
 	 * @since 1.3.0
 	 */
-	public static final ParserRegistry REGISTRY = new ParserRegistry(/* new OperationGroups(), new VariableConverter(),*/ new StringConverter(), /*new ObjectConverter(),*/ /*TODO: remove new ArrayConverter(),*/ new NumberConverter(), new BooleanConverter(), new CharacterConverter(), new NullConverter(), new SerializableBase64Converter());
+	public static final ParserRegistry REGISTRY = new ParserRegistry(new VariableParser(), new StringConverter(), new ProtocolConverter(), new NumberConverter(), new BooleanConverter(), new CharacterConverter(), new NullConverter(), new SerializableBase64Converter());
 
 	/**
 	 * @param myHomeRegistry | Registry where this parser is registered provided by {@link DataParser#parseObj(Registry, String, boolean, Class[], Object...)} otherwise it demands on implementation (it should not be null)!

SerialX-core/src/main/java/org/ugp/serialx/converters/VariableParser.java

@@ -0,0 +1,103 @@
+package org.ugp.serialx.converters;
+
+import static org.ugp.serialx.Utils.Clone;
+import static org.ugp.serialx.Utils.contains;
+import static org.ugp.serialx.Utils.splitValues;
+
+import org.ugp.serialx.GenericScope;
+import org.ugp.serialx.Registry;
+import org.ugp.serialx.Scope;
+import org.ugp.serialx.Serializer;
+
+/**
+ * This parser is capable of reading variables from {@link GenericScope} by using "$"!
+ * {@link VariableConverter#parse(String, Object...)} required one additional Scope argument in args... at index 0!
+ * Its case sensitive!<br>
+ * Exact outputs of this converter are based on inserted scope!
+ * 
+ * @author PETO
+ *	
+ * @since 1.3.7
+ */
+public class VariableParser implements DataParser
+{
+	@SuppressWarnings("unchecked")
+	@Override
+	public Object parse(ParserRegistry myHomeRegistry, String str, Object... args) 
+	{
+		if (args.length > 0 && str.length() > 0 && args[0] instanceof GenericScope)
+		{
+			return parse(myHomeRegistry, str, (GenericScope<Object, Object>) args[0], args);
+		}
+		return CONTINUE;
+	}
+
+	/**
+	 * @param myHomeRegistry | Registry where this parser is registered provided by {@link DataParser#parseObj(Registry, String, boolean, Class[], Object...)} otherwise it demands on implementation (it should not be null)!
+	 * @param str | Source string (preferably with some variables to read)!
+	 * @param scope | Source scope to read from, can't be null!
+	 * @param args | Some additional args. This can be anything and it demands on implementation of DataParser.
+	 * 
+	 * @return Value of variable read from scope is str was suitable. Special return types are {@link DataParser#VOID} and {@link DataParser#CONTINUE}. Continue will ignore this parser and jump to another one in registry.
+	 * 
+	 * @since 1.3.7
+	 */
+	@SuppressWarnings("unchecked")
+	protected Object parse(ParserRegistry myHomeRegistry, String str, GenericScope<?, Object> scope, Object... args) 
+	{
+		if (str.charAt(0) == '$' && !contains(str, ' ', '+', '-', '*', '/', '%', '>', '<', '=', '&', '|', '^', '?', '='))
+		{
+
+			boolean clsModif = str.endsWith("::class"), newModif = false; // Handle modifiers...
+			if (clsModif)
+				str = str.substring(0, str.length()-7);
+			else if (newModif = str.endsWith("::new"))
+				str = str.substring(0, str.length()-5);
+			
+			Object obj = null;
+			if ((str = str.substring(1)).indexOf('.') > -1)
+			{
+				Object[] path = splitValues(str, '.');
+				int iLast = path.length-1;
+				
+				backlook: do 
+				{
+					Object sc = scope.variables().getOrDefault(path[0], VOID);
+					if (sc instanceof GenericScope) // The first one has to be scope!
+					{
+						for (int i = 1; i < iLast; i++) // Subscope/forward lookup...
+							if (!((sc = ((GenericScope<Object, ?>) sc).get(path[i])) instanceof GenericScope))
+							{
+								// LogProvider.instance.logErr("Value of path \"" + arg + "\" cannot be dereferenced because \"" + path[i] + "\" is not a scope but " + sc + "!", null);
+								break backlook;
+							}
+						
+						obj = ((GenericScope<?, Object>) sc).variables().get(path[iLast]);
+						break;
+					}
+					
+					if (sc != VOID) // = variable was defined in parent but it is not a scope, it means we want to break cos we can't deref that = treat the path as invalid (undefined)...
+					{
+						// LogProvider.instance.logErr("Value of path \"" + arg + "\" cannot be dereferenced because \"" + path[0] + "\" is not a scope but " + sc + "!", null);
+						break;
+					}
+				}
+				while ((scope = scope.getParent()) != null);
+			}
+			else
+			{
+				do 
+				{
+					if ((obj = scope.variables().getOrDefault(str, VOID)) != VOID)
+						break;
+				}
+				while ((scope = scope.getParent()) != null);
+			}
+
+			if (obj == null || obj == VOID) // When was not found...
+				return null;
+			return clsModif ? obj.getClass() : newModif ? Clone(obj, scope instanceof Serializer ? ((Serializer) scope).getParsers() : DataParser.REGISTRY, new Object[] {}, new Scope()) : obj;
+		}
+		return CONTINUE;
+	}
+}

SerialX-juss/src/main/java/org/ugp/serialx/juss/JussSerializer.java

@@ -701,13 +701,13 @@ public <T> T cloneOf(String variableName)
 	 * @param variable | Variable to clone!
 	 * @param defaultValue | Default value to return.
 	 * 
-	 * @return Clone of value stored by variable with inserted name or defaultValue if there is no such a one!
+	 * @return Clone of value stored by variable with inserted name or defaultValue if there is no such a one or given key contains null!
 	 * <br><br>
 	 * Note: Cloning is done by {@link Serializer#Clone(Object, Registry, Object[], Object...))}!
 	 * 
 	 * @since 1.3.2
 	 */
-	public <T> T cloneOf(String variableName , T defaultValue)
+	public <T> T cloneOf(String variableName, T defaultValue)
 	{
 		T obj = get(variableName , defaultValue);
 		if (obj == defaultValue)