ConfigObject.java

/*
 * Copyright 2015 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.config;

import com.google.common.reflect.TypeToken;

/**
 * An object deserialized from config.
 *
 * @param <T> the type of object
 * @see ConfigData#getAsConfigObject(String, TypeToken)
 */
public interface ConfigObject<T> {

  /**
   * The path to the config item.
   *
   * @return the path to the config item
   */
  String getPath();

  /**
   * The raw type of the config item.
   *
   * @return the raw type of the config item
   */
  Class<T> getType();

  /**
   * The complete type of the config item.
   *
   * @return the complete type of the config item
   * @since 1.4
   */
  TypeToken<T> getTypeToken();

  /**
   * The bound object.
   *
   * @return the bound object
   */
  T getObject();

}