Preference.java

/**
 * Copyright 2016-2017 Linagora, Université Joseph Fourier, Floralis
 *
 * The present code is developed in the scope of the joint LINAGORA -
 * Université Joseph Fourier - Floralis research program and is designated
 * as a "Result" pursuant to the terms and conditions of the LINAGORA
 * - Université Joseph Fourier - Floralis research program. Each copyright
 * holder of Results enumerated here above fully & independently holds complete
 * ownership of the complete Intellectual Property rights applicable to the whole
 * of said Results, and may freely exploit it in any manner which does not infringe
 * the moral rights of the other copyright holders.
 *
 * 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 net.roboconf.core.model.runtime;

/**
 * @author Vincent Zurczak - Linagora
 */
public class Preference {

	private final String name, value;
	private final PreferenceKeyCategory category;


	/**
	 * Constructor.
	 * @param name the key name (not null)
	 * @param category the category (can be null)
	 */
	public Preference( String name, String value, PreferenceKeyCategory category ) {
		this.name = name;
		this.value = value;
		this.category = category;
	}

	public String getName() {
		return this.name;
	}

	public String getValue() {
		return this.value;
	}

	public PreferenceKeyCategory getCategory() {
		return this.category;
	}

	@Override
	public String toString() {
		return this.name;
	}


	/**
	 * @author Vincent Zurczak - Linagora
	 */
	public enum PreferenceKeyCategory {
		WEB( "Web" ),
		EMAIL( "Email settings (when Roboconf has to send e-mails)" ),
		AUTONOMIC( "Autonomic" ),
		MISCELLANEOUS( "Miscellaneous properties" );

		private String description;
		private PreferenceKeyCategory( String description ) {
			this.description = description;
		}

		public String getDescription() {
			return this.description;
		}

		public static PreferenceKeyCategory which( String s ) {

			PreferenceKeyCategory result = null;
			for( PreferenceKeyCategory cat : values()) {
				if( cat.toString().equalsIgnoreCase( s )) {
					result = cat;
					break;
				}
			}

			return result;
		}
	}
}