Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache.kahadb.util » [javadoc | source]
    1   /**
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   package org.apache.kahadb.util;
   18   
   19   import java.io.DataInput;
   20   import java.io.DataOutput;
   21   import java.io.IOException;
   22   
   23   /**
   24    * @version $Revision: 816280 $
   25    */
   26   public interface Marshaller<T> {
   27       
   28       /**
   29        * Write the payload of the object to the DataOutput stream.
   30        * 
   31        * @param object 
   32        * @param dataOut
   33        * @throws IOException
   34        */
   35       void writePayload(T object, DataOutput dataOut) throws IOException;
   36       
   37       
   38       /**
   39        * Read the payload of the object from the DataInput stream.
   40        * 
   41        * @param dataIn 
   42        * @return unmarshalled object
   43        * @throws IOException
   44        */
   45       T readPayload(DataInput dataIn) throws IOException;
   46   
   47       /** 
   48        * @return -1 if the object do not always marshall to a fixed size, otherwise return that fixed size.
   49        */
   50       int getFixedSize();
   51       
   52       /**
   53        * 
   54        * @return true if the {@link #deepCopy(Object)} operations is supported.
   55        */
   56       boolean isDeepCopySupported();
   57   
   58       /**
   59        * @return a deep copy of the source object.
   60        */
   61       T deepCopy(T source);
   62      
   63   }

Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache.kahadb.util » [javadoc | source]