Byteable


1   /*
2    * Copyright 2002 by
3    * <a HREF="http://www.coridan.com">Coridan</a>
4    * <a HREF="mailto: support@coridan.com ">support@coridan.com</a>
5    *
6    * The contents of this file are subject to the Mozilla Public License Version
7    * 1.1 (the "License"); you may not use this file except in compliance with the
8    * License.  You may obtain a copy of the License at
9    * http://www.mozilla.org/MPL/
10   *
11   * Software distributed under the License is distributed on an "AS IS" basis,
12   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13   * for the specific language governing rights and limitations under the
14   * License.
15   *
16   * The Original Code is "MantaRay" (TM).
17   *
18   * The Initial Developer of the Original Code is Amir Shevat.
19   * Portions created by the Initial Developer are Copyright (C) 2006
20   * Coridan Inc.  All Rights Reserved.
21   *
22   * Contributor(s): all the names of the contributors are added in the source
23   * code where applicable.
24   *
25   * Alternatively, the contents of this file may be used under the terms of the
26   * LGPL license (the "GNU LESSER GENERAL PUBLIC LICENSE"), in which case the
27   * provisions of LGPL are applicable instead of those above.  If you wish to
28   * allow use of your version of this file only under the terms of the LGPL
29   * License and not to allow others to use your version of this file under
30   * the MPL, indicate your decision by deleting the provisions above and
31   * replace them with the notice and other provisions required by the LGPL.
32   * If you do not delete the provisions above, a recipient may use your version
33   * of this file under either the MPL or the GNU LESSER GENERAL PUBLIC LICENSE.
34   
35   *
36   * This library is free software; you can redistribute it and/or modify it
37   * under the terms of the MPL as stated above or under the terms of the GNU
38   * Lesser General Public License as published by the Free Software Foundation;
39   * either version 2.1 of the License, or any later version.
40   *
41   * This library is distributed in the hope that it will be useful, but WITHOUT
42   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
43   * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
44   * License for more details.
45   */
46  /*
47   * Created on Feb 12, 2004
48   * Manta LTD
49   */
50  package org.mr.core.util.byteable;
51  
52  import java.io.IOException  ;
53  
54  /**
55   * Byteable is an interface that objects passing to the network or to a persistent storage 
56   * needs to implement. It enables Polymorphism and encapsulates the Marshalling and 
57   * unMarshalling
58   * @since Feb 12, 2004
59   * @version 1.0
60   * @author Amir Shevat
61   */
62  public interface Byteable {
63      
64      /**
65       * In order to have Polymorphism when reading and writing this object we need to know its type
66       * @return a Unique name (e.g.  org.mr.core.protocol.Byteable)
67       */
68      public String   getByteableName();
69      
70      /**
71       * This object must know how to transform itself and its members into bytes using this 
72       * ByteableOutputStream.
73       * @param out the object that holds the bytes
74       */
75      public void toBytes(ByteableOutputStream out) throws IOException  ;
76      
77      /**
78       * This object must know how to init itself out of a buffer using this ByteableInputStream.
79       * @param in the object that holds the bytes.
80       * @return this method can return a new or the same bytable object.
81       */
82      public Byteable createInstance(ByteableInputStream in) throws IOException  ;
83      
84      /**
85       * The ByteableRegistry holds the factories to all the byteable objects.
86       * When a byteable object is read from a buffer, we go to the registry and
87       * invoke the fromBytes to get an instance of the byteable object.
88       */
89      public void registerToByteableRegistry();
90  
91  }
92
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags