1 /* 2 * Copyright 2015 Google LLC 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 17 package com.google.cloud; 18 19 /** 20 * A common interface for restorable states. Implementations of {@code RestorableState} are capable 21 * of saving the state of an object to restore it for later use. 22 * 23 * <p>Implementations of this class must implement {@link java.io.Serializable} to ensure that the 24 * state of a the object can be correctly serialized. 25 * 26 * @param <T> the restored object's type 27 */ 28 public interface RestorableState<T extends Restorable<T>> { 29 30 /** Returns an object whose internal state reflects the one saved in the invocation object. */ restore()31 T restore(); 32 } 33