org.cfg4j.source.context.propertiesprovider.PropertiesProvider Maven / Gradle / Ivy

/*
 * 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 org.cfg4j.source.context.propertiesprovider;

import java.io.InputStream;
import java.util.Properties;

/**
 * Transforms {@link InputStream} into {@link Properties}.
 */
public interface PropertiesProvider {

  /**
   * Get {@link Properties} for a given {@code inputStream}.
   *
   * @param inputStream input stream to convert
   * @return properties representing values from {@code inputStream}
   * @throws IllegalStateException when unable to read properties
   */
  Properties getProperties(InputStream inputStream);

}