ratpack.registry.RegistrySpecAction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ratpack-core Show documentation
null
There is a newer version: 2.0.0-rc-1
/*
 * Copyright 2014 the 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 ratpack.registry;

import com.google.common.reflect.TypeToken;
import ratpack.func.Action;
import ratpack.func.Factory;

/**
 * A convenient action base class for a registry spec.
 */
public abstract class RegistrySpecAction implements Action, RegistrySpec {

  private RegistrySpec registrySpec;

  /**
   * Returns the registry spec being delegated to.
   *
   * @return the registry spec being delegated to.
   * @throws IllegalStateException if called outside of {@link #execute()}
   */
  protected RegistrySpec getRegistrySpec() throws IllegalStateException {
    if (registrySpec == null) {
      throw new IllegalStateException("no registry spec set - RegistrySpec methods should only be called during execute()");
    }
    return registrySpec;
  }

  /**
   * Delegates to {@link #execute()}, using the given {@code registrySpec} for delegation.
   *
   * @param registrySpec the registry spec
   * @throws Exception Any thrown by {@link #execute()}
   */
  public final void execute(RegistrySpec registrySpec) throws Exception {
    try {
      this.registrySpec = registrySpec;
      execute();
    } finally {
      this.registrySpec = null;
    }
  }

  /**
   * Implementations can naturally use the {@link RegistrySpec} DSL for the duration of this method.
   *
   * @throws Exception Any exception thrown while adding to the registry
   */
  protected abstract void execute() throws Exception;

  /**
   * {@inheritDoc}
   */
  @Override
  public  RegistrySpec add(Class type, O object) {
    return getRegistrySpec().add(type, object);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  RegistrySpec add(TypeToken type, O object) {
    return getRegistrySpec().add(type, object);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public RegistrySpec add(Object object) {
    return getRegistrySpec().add(object);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  RegistrySpec add(Class type, Factory factory) {
    return getRegistrySpec().add(type, factory);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public  RegistrySpec add(TypeToken type, Factory factory) {
    return getRegistrySpec().add(type, factory);
  }

}