LifecycleRegistration.java

/**
 * Copyright 2014 Sunny Gleason and original author or authors
 *
 * 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 io.kazuki.v0.store.lifecycle;


/**
 * Objects should implement LifecycleRegistration so that the container will inject the singleton
 * Lifecycle instance to them for registration. Typical usage is something like this:
 * 
 * <pre>
 * class Foo implements LifecycleRegistration, LifecycleAware {
 *     @Override
 *     public void register(Lifecycle lifecycle) {
 *         lifecycle.register(this);
 *     }
 * 
 *     @Override
 *     public void eventFired(LifecycleEvent event) {
 *         // do stuff
 *     }
 * }
 * </pre>
 */
public interface LifecycleRegistration {
  Lifecycle getLifecycle();

  void register(Lifecycle lifecycle);
}