io.vertigo.core.param.ParamManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-core Show documentation
Vertigo is a simple java starter
The newest version!
/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013-2016, KleeGroup, [email protected] (http://www.kleegroup.com)
 * KleeGroup, Centre d'affaire la Boursidiere - BP 159 - 92357 Le Plessis Robinson Cedex - France
 *
 * 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 io.vertigo.core.param;

import io.vertigo.lang.Manager;

/**
 * Interface du gestionnaire de la configuration applicative.
 *
 * Une configuration possède une liste de paramètres.
 * Un paramètre est
 *  - identifié par un nom.
 *  - camelCase.camelCase et ne contient que des lettres et chiffres; les séparateurs sont des points.
 *
 * Les paramètres sont de trois types :
 * -boolean
 * -String
 * -int
 *
 *
 * Exemple en json :
 *
 * {
 *  server.host : "wiki",
 *  server.port : "5455",
 *  maxUsers  :"10",
 * }
 *
 *
 * getStringValue("server.host") => wiki
 * getStringValue("host") => erreur.
 *
 * @author pchretien, npiedeloup, prahmoune
 */
public interface ParamManager extends Manager {
	/**
	 * Returns the value for a param, defined by its name.
	 * @param paramName Name of the param
	 * @param paramType Type of the param
	 * @return the value of the param
	 */
	 C getValue(String paramName, Class paramType);

	/**
	 * Returns a param as a String.
	 * @param paramName param's name
	 * @return the value of the param
	 */
	String getStringValue(final String paramName);

	/**
	 * Returns a param as an int.
	 * @param paramName Name of the param
	 * @return the value of the param
	 */
	int getIntValue(String paramName);

	/**
	 * Returns a param as a long.
	 * @param paramName Name of the param
	 * @return the value of the param
	 */
	long getLongValue(final String paramName);

	/**
	 * Returns a param as a boolean .
	 * @param paramName Name of the param
	 * @return the value of the param
	 */
	boolean getBooleanValue(String paramName);
}