Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.tang;
020
021/**
022 * This interface is used to track the source of configuration bindings.
023 * <p>
024 * This can be explicitly set (such as by configuration file parsers), or be
025 * implicitly bound to the stack trace of bind() invocation.
026 */
027public interface BindLocation {
028  /**
029   * Implementations of BindLocation should override toString() so that it
030   * returns a human readable representation of the source of the
031   * configuration option in question.
032   *
033   * @return A (potentially multi-line) string that represents the stack
034   * trace, configuration file location, or other source of some
035   * configuration data.
036   */
037  String toString();
038}