io.protostuff.parser.Field Maven / Gradle / Ivy
//========================================================================
//Copyright 2007-2009 David Yu [email protected]
//------------------------------------------------------------------------
//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//http://www.apache.org/licenses/LICENSE-2.0
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
//========================================================================
package io.protostuff.parser;
import java.nio.ByteBuffer;
import java.util.LinkedHashMap;
/**
* Base class for fields defined in a {@link Message}.
*
* @author David Yu
* @created Dec 19, 2009
*/
public abstract class Field extends AnnotationContainer implements Comparable>, HasName, HasOptions
{
public enum Modifier
{
OPTIONAL,
REQUIRED,
REPEATED;
public java.lang.String getName()
{
return name().toLowerCase();
}
}
java.lang.String name, defaultValueConstant;
int number;
Modifier modifier;
boolean packable;
T defaultValue;
Message owner;
final LinkedHashMap standardOptions =
new LinkedHashMap();
final LinkedHashMap extraOptions =
new LinkedHashMap();
public Field()
{
}
public Field(boolean packable)
{
this.packable = packable;
}
@Override
public Proto getProto()
{
return owner == null ? null : owner.getProto();
}
public LinkedHashMap getStandardOptions()
{
return standardOptions;
}
public LinkedHashMap getExtraOptions()
{
return extraOptions;
}
public LinkedHashMap getO()
{
return getOptions();
}
/**
* Returns this options
*/
@Override
public LinkedHashMap getOptions()
{
return extraOptions;
}
/**
* Returns the option defined by the {@code key}.
*/
@SuppressWarnings("unchecked")
public V getOption(java.lang.String key)
{
return (V) extraOptions.get(key);
}
public boolean hasOption(java.lang.String key)
{
return extraOptions.containsKey(key);
}
@Override
public void putStandardOption(java.lang.String key, Object value)
{
putExtraOption(key, value);
standardOptions.put(key, value);
}
@Override
public void putExtraOption(java.lang.String key, Object value)
{
if (extraOptions.put(key, value) != null)
{
final Proto proto;
final java.lang.String ofOwner;
if (owner != null)
{
proto = owner.getProto();
ofOwner = " of " + owner.getRelativeName();
}
else
{
proto = null;
ofOwner = "";
}
throw err("The field " + name + ofOwner +
" contains a duplicate option: " + key, proto);
}
}
/**
* @return the name
*/
@Override
public java.lang.String getName()
{
return name;
}
public java.lang.String getDefaultValueConstant()
{
return defaultValueConstant;
}
/**
* @return the number
*/
public int getNumber()
{
return number;
}
/**
* @return the modifier
*/
public Modifier getModifier()
{
return modifier;
}
/**
* @return the packable
*/
public boolean isPackable()
{
return packable;
}
/**
* @return the defaultValue
*/
public T getDefaultValue()
{
return defaultValue;
}
public boolean isRepeated()
{
return modifier == Modifier.REPEATED;
}
public boolean isRequired()
{
return modifier == Modifier.REQUIRED;
}
public boolean isOptional()
{
return modifier == Modifier.OPTIONAL;
}
public boolean isDefaultValueSet()
{
return getDefaultValue() != null;
}
public boolean isNumberField()
{
return Number.class.isAssignableFrom(getClass());
}
public boolean isEnumField()
{
return EnumField.class.isAssignableFrom(getClass());
}
public boolean isMessageField()
{
return MessageField.class.isAssignableFrom(getClass());
}
public boolean isBytesField()
{
return Bytes.class.isAssignableFrom(getClass());
}
public boolean isStringField()
{
return String.class.isAssignableFrom(getClass());
}
public boolean isBoolField()
{
return Bool.class.isAssignableFrom(getClass());
}
public boolean isDelimited()
{
return false;
}
public java.lang.String toString()
{
return new StringBuilder()
.append('{')
.append("type:").append(getClass().getSimpleName())
.append(',').append("name:").append(name)
.append(',').append("number:").append(number)
.append(',').append("modifier:").append(modifier)
.append(',').append("packable:").append(packable)
.append(',').append("defaultValue:").append(defaultValue)
.append('}')
.toString();
}
@Override
public int compareTo(Field f)
{
if (f.number == number)
{
throw err("The field: " + f.name + " cannot have the same number as " +
name, owner == null ? null : owner.getProto());
}
return f.number < number ? 1 : -1;
}
public abstract java.lang.String getJavaType();
/**
* Returns field type for proto files. Scalar value types:
* https://developers.google.com/protocol-buffers/docs/proto#scalar
*
* @return .proto type
*/
public java.lang.String getProtoType()
{
return this.getClass().getSimpleName().toLowerCase();
}
public java.lang.String getDefaultValueAsString()
{
return getDefaultValue().toString();
}
public Message getOwner()
{
return owner;
}
static abstract class Number extends Field
{
public Number()
{
super(true);
}
}
public static class Int32 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "int";
}
}
public static class UInt32 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "int";
}
}
public static class SInt32 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "int";
}
}
public static class Fixed32 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "int";
}
}
public static class SFixed32 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "int";
}
}
public static class Int64 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "long";
}
}
public static class UInt64 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "long";
}
}
public static class SInt64 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "long";
}
}
public static class Fixed64 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "long";
}
}
public static class SFixed64 extends Number
{
@Override
public java.lang.String getJavaType()
{
return "long";
}
}
public static class Float extends Number
{
@Override
public java.lang.String getJavaType()
{
return "float";
}
}
public static class Double extends Number
{
@Override
public java.lang.String getJavaType()
{
return "double";
}
}
public static class Bool extends Field
{
public Bool()
{
super(true);
}
@Override
public java.lang.String getJavaType()
{
return "boolean";
}
}
public static class String extends Field
{
public String()
{
super(false);
}
@Override
public java.lang.String getJavaType()
{
return "String";
}
@Override
public java.lang.String getDefaultValueAsString()
{
return TextFormat.escapeText(getDefaultValue());
}
@Override
public boolean isDelimited()
{
return true;
}
}
public static class Bytes extends Field
{
public Bytes()
{
super(false);
}
@Override
public java.lang.String getJavaType()
{
if (hasOption("ByteBuffer"))
return "ByteBuffer";
else
return "ByteString";
}
@Override
public java.lang.String getDefaultValueAsString()
{
return TextFormat.escapeBytes(ByteBuffer.wrap(getDefaultValue())).toString();
}
@Override
public boolean isDelimited()
{
return true;
}
}
public static class Reference extends Field © 2015 - 2025 Weber Informatics LLC | Privacy Policy