wamblee.org Git - utils/blob - support/general/src/main/java/org/wamblee/persistence/Detachable.java

   1 /*
   2  * Copyright 2005-2010 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.wamblee.persistence;
  17
  18 import java.io.Serializable;
  19
  20 /**
  21  * Represents a detachable object. It represent a reference to a persistent object.
  22  * The object is detachable in that the memory footprint can be reduced by not keeping
  23  * a reference to the complete java object, but only to its identify in persistent
  24  * storage. This is typically the primary key in a relational database.
  25  */
  26 public interface Detachable<T> extends Serializable {
  27
  28         /**
  29          * Detaches the object.
  30          */
  31         void detach();
  32
  33         /**
  34          * Gets the object, attaching it if needed.
  35          * @return
  36          */
  37         T get();
  38
  39 }