net.officefloor.eclipse.extension.WoofExtensionUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of net.officefloor.woof Show documentation
OfficeFloor WoOF Eclipse plug-in
There is a newer version: 3.12.0
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2013 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.eclipse.extension;

import java.util.List;
import java.util.Map;

import net.officefloor.eclipse.WoofPlugin;
import net.officefloor.eclipse.extension.access.HttpSecuritySourceExtension;
import net.officefloor.eclipse.extension.template.WoofTemplateExtensionSourceExtension;
import net.officefloor.plugin.web.http.security.HttpSecuritySource;
import net.officefloor.plugin.woof.template.WoofTemplateExtensionSource;

/**
 * Utility class for working with extensions.
 * 
 * @author Daniel Sagenschneider
 */
public class WoofExtensionUtil extends ExtensionUtil {

	/**
	 * Obtains the extension id for the input extension name.
	 * 
	 * @param name
	 *            Name of the extension.
	 * @return Id for the extension.
	 */
	public static String getExtensionId(String name) {
		return WoofPlugin.PLUGIN_ID + "." + name;
	}

	/**
	 * {@link SourceClassExtractor} for the {@link HttpSecuritySourceExtension}.
	 */
	@SuppressWarnings("rawtypes")
	private static final SourceClassExtractor HTTP_SECURITY_SOURCE_CLASS_EXTRACTOR = new SourceClassExtractor() {
		@Override
		public Class getSourceClass(
				HttpSecuritySourceExtension sourceExtension) {
			return sourceExtension.getHttpSecuritySourceClass();
		}
	};

	/**
	 * Creates the map of {@link HttpSecuritySourceExtension} instances by their
	 * respective {@link HttpSecuritySource} class name.
	 * 
	 * @return Map of {@link HttpSecuritySourceExtension} instances by their
	 *         respective {@link HttpSecuritySource} class name.
	 */
	@SuppressWarnings("rawtypes")
	public static Map createHttpSecuritySourceExtensionMap() {
		return ExtensionUtil.createSourceExtensionMap(
				HttpSecuritySourceExtension.EXTENSION_ID,
				HttpSecuritySourceExtension.class,
				HTTP_SECURITY_SOURCE_CLASS_EXTRACTOR);
	}

	/**
	 * Creates the listing of {@link HttpSecuritySourceExtension} instances.
	 * 
	 * @return Listing of {@link HttpSecuritySourceExtension} instances.
	 */
	@SuppressWarnings("rawtypes")
	public static List createHttpSecuritySourceExtensionList() {
		return createSourceExtensionList(createHttpSecuritySourceExtensionMap());
	}

	/**
	 * {@link SourceClassExtractor} for the
	 * {@link WoofTemplateExtensionSourceExtension}.
	 */
	@SuppressWarnings("rawtypes")
	private static final SourceClassExtractor WOOF_TEMPLATE_EXTENSION_SOURCE_CLASS_EXTRACTOR = new SourceClassExtractor() {
		@Override
		public Class getSourceClass(
				WoofTemplateExtensionSourceExtension sourceExtension) {
			return sourceExtension.getWoofTemplateExtensionSourceClass();
		}
	};

	/**
	 * Creates the map of {@link WoofTemplateExtensionSourceExtension} instances
	 * by their respective {@link WoofTemplateExtensionSource} class name.
	 * 
	 * @return Map of {@link WoofTemplateExtensionSourceExtension} instances by
	 *         their respective {@link WoofTemplateExtensionSource} class name.
	 */
	@SuppressWarnings("rawtypes")
	public static Map createWoofTemplateExtensionSourceExtensionMap() {
		return ExtensionUtil.createSourceExtensionMap(
				WoofTemplateExtensionSourceExtension.EXTENSION_ID,
				WoofTemplateExtensionSourceExtension.class,
				WOOF_TEMPLATE_EXTENSION_SOURCE_CLASS_EXTRACTOR);
	}

	/**
	 * Creates the listing of {@link WoofTemplateExtensionSourceExtension}
	 * instances.
	 * 
	 * @return Listing of {@link WoofTemplateExtensionSourceExtension}
	 *         instances.
	 */
	@SuppressWarnings("rawtypes")
	public static List createWoofTemplateExtensionSourceExtensionList() {
		return createSourceExtensionList(createWoofTemplateExtensionSourceExtensionMap());
	}

	/**
	 * All access via static methods.
	 */
	private WoofExtensionUtil() {
	}

}