net.stickycode.configured.ConfigurationKeyBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sticky-configured-api Show documentation

Taking the configuration out of applications, using the same principles that underly dependency injection

There is a newer version: 5.7

Show newest version

/**
 * Copyright (c) 2010 RedEngine Ltd, http://www.redengine.co.nz. All rights reserved.
 *
 * This program is licensed to you under the Apache License Version 2.0,
 * and you may not use this file except in compliance with the Apache License Version 2.0.
 * You may obtain a copy of the Apache License Version 2.0 at http://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the Apache License Version 2.0 is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Apache License Version 2.0 for the specific language governing permissions and limitations there under.
 */
package net.stickycode.configured;

/**
 * Contract for defining the format of keys used to lookup configuration.
 */
public interface ConfigurationKeyBuilder {

  @Deprecated
  String buildKey(Configuration configuration, ConfigurationAttribute attribute);

  /**
   * Build a composite key to identify a configuration, all configuration keys belong to a group and have a name
   * 
   * @param group The group of configurations
   * @param name The name of one element of a configuration group
   * @return The key for the configuration lookup
   */
  String build(ConfigurationKeyElement group, ConfigurationKeyElement name);

}