org.openbase.jul.extension.protobuf.processing

Class ProtoBufFileProcessor<DT,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>

java.lang.Object

org.openbase.jul.extension.protobuf.processing.ProtoBufFileProcessor<DT,M,MB>

Type Parameters:

DT - datatype

M - message

MB - message builder

All Implemented Interfaces:

FileProcessor<DT>, Processor<DT,File>

public class ProtoBufFileProcessor<DT,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder<MB>>
extends Object
implements FileProcessor<DT>

Helper class to serialize and deserialize protobuf objects into json files and vise versa. Example Code:

 
     ProtoBufFileProcessor<UserConfig, UserConfig, UserConfig.Builder> processor = new ProtoBufFileProcessor<>(UserConfig.newBuilder());
     processor.serialize(UserConfig.getDefaultInstance().newBuilderForType().setFirstName("Pink").build(), new File("/tmp/myuser.txt"));
     System.out.println("Username: "+processor.deserialize(new File("/tmp/myuser.txt")).getFirstName());
 
 

Author:

Divine Threepwood

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtoBufFileProcessor.SimpleMessageTransformer<M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.GeneratedMessage.Builder>
static interface	ProtoBufFileProcessor.TypeToMessageTransformer<T,M extends com.google.protobuf.GeneratedMessage,MB extends com.google.protobuf.Message.Builder>

Constructor Summary

Constructors

Constructor and Description
ProtoBufFileProcessor(MB messageBuilder) Constructor to create a new ProtoBufFileProcessor
ProtoBufFileProcessor(ProtoBufFileProcessor.TypeToMessageTransformer<DT,M,MB> transformer)

Method Summary

Modifier and Type	Method and Description
DT	deserialize(File file)
DT	deserialize(File file, DT data)
File	serialize(DT data, File file)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtoBufFileProcessor

public ProtoBufFileProcessor(MB messageBuilder)

Constructor to create a new ProtoBufFileProcessor

Parameters:

messageBuilder - a builder which can be used to build the message after deserialization.

ProtoBufFileProcessor

public ProtoBufFileProcessor(ProtoBufFileProcessor.TypeToMessageTransformer<DT,M,MB> transformer)

Method Detail

deserialize

public DT deserialize(File file,
                      DT data)
               throws CouldNotPerformException

Specified by:

deserialize in interface Processor<DT,File>

Throws:

CouldNotPerformException

serialize

public File serialize(DT data,
                      File file)
               throws CouldNotPerformException

Specified by:

serialize in interface Processor<DT,File>

Throws:

CouldNotPerformException

deserialize

public DT deserialize(File file)
               throws CouldNotPerformException

Specified by:

deserialize in interface FileProcessor<DT>

Throws:

CouldNotPerformException