ControllerConfig.java

/*
 * Copyright (C) 2014 Civilian Framework.
 *
 * Licensed under the Civilian License (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.civilian-framework.org/license.txt
 *
 * 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.civilian.controller;


import org.civilian.Application;
import org.civilian.util.Check;


/**
 * ControllerConfig stores controller related configurations.
 * @see Application#getControllerConfig() 
 */
public class ControllerConfig
{
	/**
	 * Creates a new ControllerConfig.
	 */
	public ControllerConfig(String rootPackage, ControllerNaming naming)
	{
		rootPackage_ = Check.notNull(rootPackage, "rootPackage");
		naming_ 	 = naming != null ? naming : new ControllerNaming();
	}
	
	
	/**
	 * Returns the root package of the application controller classes.
	 * The root package is specified in the application constructor.
	 */
	public String getRootPackage()
	{
		return rootPackage_;
	}
	
	
	/**
	 * Returns the ControllerNaming which provides naming conventions
	 * for controller classes.
	 * The naming is specified in the application constructor.
	 * @see Application#Application(org.civilian.resource.PathParamMap, String, ControllerNaming)
	 */
	public ControllerNaming getNaming()
	{
		return naming_;
	}

	
	private String rootPackage_;
	private ControllerNaming naming_;
}