org.cp.elements.context.configure.ConfigurationAware Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2011-Present 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 org.cp.elements.context.configure;

/**
 * The {@link ConfigurationAware} interface specifies a contract for {@link Object objects} that require a reference to
 * a {@link Configuration} instance.
 *
 * @author John J. Blum
 * @see java.lang.FunctionalInterface
 * @see org.cp.elements.context.configure.Configuration
 * @since 1.0.0
 */
@FunctionalInterface
@SuppressWarnings("unused")
public interface ConfigurationAware {

  /**
   * Sets a reference to an instance of the Java application (program) {@link Configuration} in use.
   *
   * @param configuration {@link Configuration} used by the Java application (program).
   * @see org.cp.elements.context.configure.Configuration
   */
  void setConfiguration(Configuration configuration);

}