com.alipay.sofa.common.config.ConfigSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sofa-common-tools Show documentation

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 com.alipay.sofa.common.config;

import com.alipay.sofa.common.utils.Ordered;

/**
 * @author zhaowang
 * @version : ConfigSource.java, v 0.1 2020年10月20日 7:57 下午 zhaowang Exp $
 *
 */
public interface ConfigSource extends Ordered {

    /**
     * Get config by configKey. If no value exists, return null or empty string
     * @param key ConfigKey
     * @param 
     * @return value of key
     */
     T getConfig(ConfigKey key);

    /**
     * @return The name of ConfigSource
     */
    String getName();

    /**
     * Get the string value of key
     * @param key ConfigKey
     * @return string value of key
     */
    String getStringConfig(ConfigKey key);

    /**
     * The actual effective key to get the value.
     * @param configKey ConfigKey
     * @return
     */
    String getEffectiveKey(ConfigKey configKey);

}