pl.nort.config.provider.ConfigurationProviders Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of config Show documentation

Configuration management for distributed Java applications made easy.

There is a newer version: 2.0.1

/*
 * Copyright 2015 Norbert Potocki ([email protected])
 *
 * 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 pl.nort.config.provider;

import pl.nort.config.source.ConfigurationSource;
import pl.nort.config.source.GitConfigurationSource;

/**
 * A factory producing {@link ConfigurationProvider}s.
 */
public class ConfigurationProviders {

  /**
   * A {@link ConfigurationProvider} backed by {@link GitConfigurationSource}.
   *
   * @param repositoryURI a git repository URI (can be remote)
   * @return {@link ConfigurationProvider} using provided git repository as a {@link ConfigurationSource}
   */
  public static ConfigurationProvider backedByGit(String repositoryURI) {
    return new ConfigurationProviderBuilder()
        .withConfigurationSource(new GitConfigurationSource(repositoryURI))
        .build();
  }

  /**
   * A {@link ConfigurationProvider} backed by a provided {@link ConfigurationSource}.
   *
   * @param source {@link ConfigurationSource} used to supply provider with configuration
   * @return {@link ConfigurationProvider} backed by a {@code source}
   */
  public static ConfigurationProvider withSource(ConfigurationSource source) {
    return new ConfigurationProviderBuilder()
        .withConfigurationSource(source)
        .build();
  }

}