View Javadoc

1   package org.apache.jcs.engine.behavior;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.io.IOException;
23  import java.io.Serializable;
24  
25  /***
26   * Defines the behavior for cache element serializers. This layer of abstraction
27   * allows us to plug in different serialization mechanisms, such as XStream.
28   *
29   * @author Aaron Smuts
30   *
31   */
32  public interface IElementSerializer
33  {
34  
35      /***
36       * Turns an object into a byte array.
37       *
38       * @param obj
39       * @return
40       * @throws IOException
41       */
42      public abstract byte[] serialize( Serializable obj )
43          throws IOException;
44  
45      /***
46       * Turns a byte array into an object.
47       *
48       * @param bytes
49       * @return
50       * @throws IOException
51       * @throws ClassNotFoundException thrown if we don't know the object.
52       */
53      public abstract Object deSerialize( byte[] bytes )
54          throws IOException, ClassNotFoundException;
55  
56  }