org.pepstock.charba.client.impl.plugins.Crosshair Maven / Gradle / Ivy

Go to download
/**
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you 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.pepstock.charba.client.impl.plugins;

import org.pepstock.charba.client.Plugin;
import org.pepstock.charba.client.impl.plugins.CrosshairOptionsFactory.CrosshairDefaultsOptionsFactory;

/**
 * This plugin is drawing horizontal and vertical crosshair on the chart.
 * 
 * @author Andrea "Stock" Stocchero
 */
public final class Crosshair extends CharbaPluginContainer {

	/**
	 * Plugin ID {@value ID}.
	 */
	public static final String ID = "charbacrosshair";
	/**
	 * The factory to create options for plugin.
	 */
	public static final CrosshairOptionsFactory FACTORY = new CrosshairOptionsFactory();
	// singleton instance
	private static final Crosshair INSTANCE = new Crosshair();
	// defaults global options factory
	static final CrosshairDefaultsOptionsFactory DEFAULTS_FACTORY = new CrosshairDefaultsOptionsFactory();
	// instance of the plugin
	private final CrosshairPlugin pluginInstance = new CrosshairPlugin();

	/**
	 * To avoid any instantiation
	 */
	private Crosshair() {
		// do nothing
	}

	/**
	 * Returns the singleton instance of plugin.
	 * 
	 * @return the singleton instance of plugin
	 */
	public static Crosshair get() {
		return INSTANCE;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.pepstock.charba.client.impl.plugins.CharbaPluginContainer#getPluginInstance()
	 */
	@Override
	Plugin getPluginInstance() {
		return pluginInstance;
	}

}