com.dyuproject.protostuff.runtime.MappedSchema Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of protostuff-runtime Show documentation
Show all versions of protostuff-runtime Show documentation
protobuf serialization for pre-existing objects
//========================================================================
//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 com.dyuproject.protostuff.runtime;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import com.dyuproject.protostuff.Input;
import com.dyuproject.protostuff.Output;
import com.dyuproject.protostuff.Pipe;
import com.dyuproject.protostuff.Schema;
import com.dyuproject.protostuff.Tag;
import com.dyuproject.protostuff.WireFormat.FieldType;
/**
* Base class for schemas that maps fields by number and name.
* For fast initialization, the last field number is provided in the constructor.
*
* @author David Yu
* @created Nov 10, 2009
*/
public abstract class MappedSchema implements Schema
{
protected final Class typeClass;
protected final Field[] fields, fieldsByNumber;
protected final Map> fieldsByName;
protected final Pipe.Schema pipeSchema;
@SuppressWarnings("unchecked")
public MappedSchema(Class typeClass, Field[] fields, int lastFieldNumber)
{
if(fields.length==0)
throw new IllegalStateException("At least one field is required.");
this.typeClass = typeClass;
this.fields = fields;
fieldsByName = new HashMap>();
fieldsByNumber = (Field[])new Field[lastFieldNumber + 1];
for(Field f : fields)
{
Field last = this.fieldsByName.put(f.name, f);
if(last!=null)
{
throw new IllegalStateException(last + " and " + f +
" cannot have the same name.");
}
if(fieldsByNumber[f.number]!=null)
{
throw new IllegalStateException(fieldsByNumber[f.number] + " and " + f +
" cannot have the same number.");
}
fieldsByNumber[f.number] = f;
//f.owner = this;
}
pipeSchema = new RuntimePipeSchema(this, fieldsByNumber);
}
@SuppressWarnings("unchecked")
public MappedSchema(Class typeClass, Collection> fields,
int lastFieldNumber)
{
if(fields.isEmpty())
throw new IllegalStateException("At least one field is required.");
this.typeClass = typeClass;
fieldsByName = new HashMap>();
fieldsByNumber = (Field[])new Field[lastFieldNumber + 1];
for(Field f : fields)
{
Field last = this.fieldsByName.put(f.name, f);
if(last!=null)
{
throw new IllegalStateException(last + " and " + f +
" cannot have the same name.");
}
if(fieldsByNumber[f.number]!=null)
{
throw new IllegalStateException(fieldsByNumber[f.number] + " and " + f +
" cannot have the same number.");
}
fieldsByNumber[f.number] = f;
//f.owner = this;
}
this.fields = (Field[])new Field[fields.size()];
for(int i = 1, j = 0; i < fieldsByNumber.length; i++)
{
if(fieldsByNumber[i] != null)
this.fields[j++] = fieldsByNumber[i];
}
pipeSchema = new RuntimePipeSchema(this, fieldsByNumber);
}
@SuppressWarnings("unchecked")
public MappedSchema(Class typeClass, Map> fieldsByName,
int lastFieldNumber)
{
if(fieldsByName.isEmpty())
throw new IllegalStateException("At least one field is required.");
this.typeClass = typeClass;
this.fieldsByName = fieldsByName;
Collection> fields = fieldsByName.values();
fieldsByNumber = (Field[])new Field[lastFieldNumber + 1];
for(Field f : fields)
{
if(fieldsByNumber[f.number]!=null)
{
throw new IllegalStateException(fieldsByNumber[f.number] + " and " + f +
" cannot have the same number.");
}
fieldsByNumber[f.number] = f;
//f.owner = this;
}
this.fields = (Field[])new Field[fields.size()];
for(int i = 1, j = 0; i < fieldsByNumber.length; i++)
{
if(fieldsByNumber[i] != null)
this.fields[j++] = fieldsByNumber[i];
}
pipeSchema = new RuntimePipeSchema(this, fieldsByNumber);
}
/**
* Returns the message's total number of fields.
*/
public int getFieldCount()
{
return fields.length;
}
public Class typeClass()
{
return typeClass;
}
public String messageName()
{
return typeClass.getSimpleName();
}
public String messageFullName()
{
return typeClass.getName();
}
public String getFieldName(int number)
{
// only called on writes
final Field field = number < fieldsByNumber.length ?
fieldsByNumber[number] : null;
return field == null ? null : field.name;
}
public int getFieldNumber(String name)
{
final Field field = fieldsByName.get(name);
return field == null ? 0 : field.number;
}
public final void mergeFrom(Input input, T message) throws IOException
{
for (int number = input.readFieldNumber(this); number != 0;
number = input.readFieldNumber(this))
{
final Field field = number < fieldsByNumber.length ?
fieldsByNumber[number] : null;
if(field == null)
input.handleUnknownField(number, this);
else
field.mergeFrom(input, message);
}
}
public final void writeTo(Output output, T message) throws IOException
{
for(Field f : fields)
f.writeTo(output, message);
}
/**
* Returns the pipe schema linked to this.
*/
public Pipe.Schema getPipeSchema()
{
return pipeSchema;
}
/**
* Represents a field of a message/pojo.
*
*/
public static abstract class Field
{
public final FieldType type;
public final int number;
public final String name;
public final boolean repeated;
public final int groupFilter;
//public final Tag tag;
public Field(FieldType type, int number, String name, boolean repeated,
Tag tag)
{
this.type = type;
this.number = number;
this.name = name;
this.repeated = repeated;
this.groupFilter = tag == null ? 0 : tag.groupFilter();
//this.tag = tag;
}
public Field(FieldType type, int number, String name,
Tag tag)
{
this(type, number, name, false, tag);
}
/**
* Writes the value of a field to the {@code output}.
*/
protected abstract void writeTo(Output output, T message) throws IOException;
/**
* Reads the field value into the {@code message}.
*/
protected abstract void mergeFrom(Input input, T message) throws IOException;
/**
* Transfer the input field to the output field.
*/
protected abstract void transfer(Pipe pipe, Input input, Output output,
boolean repeated) throws IOException;
}
}