se.l4.commons.config.ConfigKey Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-main Show documentation
The newest version!
package se.l4.commons.config;

import java.io.IOException;

import se.l4.commons.serialization.Expose;
import se.l4.commons.serialization.ReflectionSerializer;
import se.l4.commons.serialization.Serializer;
import se.l4.commons.serialization.SerializerFormatDefinition;
import se.l4.commons.serialization.format.StreamingInput;
import se.l4.commons.serialization.format.StreamingOutput;
import se.l4.commons.serialization.format.Token;
import se.l4.commons.serialization.format.ValueType;

/**
 * A configuration key, represents the path of the config object that has been
 * deserialized. Used to resolve further configuration values.
 * 
 * 
 * Use this to deserialize any field named {@code config:key} via {@link Config}.
 * 
 * 

 * Example use with {@link Expose} and {@link ReflectionSerializer}:
 * 
 * @Expose(ConfigKey.NAME)
 * private ConfigKey configKey;
 * 
 * 
 * @author Andreas Holstenson
 *
 */
public class ConfigKey
{
	public static final String NAME = "_aurochs_:configKey";
	
	private final Config config;
	private final String key;
	
	private ConfigKey(Config config, String key)
	{
		this.config = config;
		this.key = key;
	}
	
	/**
	 * Get the value of a sub path to this key.
	 * 
	 * @param subPath
	 * @param type
	 * @return
	 */
	public  Value get(String subPath, Class type)
	{
		return config.get(key + '.' + subPath, type);
	}
	
	/**
	 * Get the value of a sub path to this key.
	 * 
	 * @param subPath
	 * @param type
	 * @return
	 */
	public  T asObject(String subPath, Class type)
	{
		return config.asObject(key + '.' + subPath, type);
	}
	
	/**
	 * Get this object as another type.
	 * 
	 * @param type
	 * @return
	 */
	public  T asObject(Class type)
	{
		return config.asObject(key, type);
	}
	

	public static class ConfigKeySerializer
		implements Serializer
	{
		private final Config config;

		public ConfigKeySerializer(Config config)
		{
			this.config = config;
		}
		
		@Override
		public ConfigKey read(StreamingInput in)
			throws IOException
		{
			in.next(Token.VALUE);
			return new ConfigKey(config, in.getString());
		}
		
		@Override
		public void write(ConfigKey object, String name, StreamingOutput stream)
			throws IOException
		{
			// Ignore this, keys should never be written
		}
		
		@Override
		public SerializerFormatDefinition getFormatDefinition()
		{
			return SerializerFormatDefinition.forValue(ValueType.STRING);
		}
	}
}