com.google.cloud.Restorable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-core Show documentation

Core module for the google-cloud.

There is a newer version: 2.43.0

/*
 * Copyright 2015 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud;

/**
 * Implementation of this interface can persist their state and restore from it.
 *
 * A typical capture usage:
 * 
 {@code
 * X restorableObj; // X instanceof Restorable
 * RestorableState state = restorableObj.capture();
 * .. persist state
 * }
 *
 * A typical restore usage:
 * 
 {@code
 * RestorableState state = ... // read from persistence
 * X restorableObj = state.restore();
 * ...
 * }
 *
 * @param  the restorable object's type
 */
public interface Restorable> {

  /**
   * Captures the state of this object.
   *
   * @return a {@link RestorableState} instance that contains the state for this object and can
   *     restore it afterwards.
   */
  RestorableState capture();
}