de.intarsys.pdf.app.annotation.IAnnotationOutlet Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.pdf.app.annotation;

import de.intarsys.pdf.cos.COSName;

/**
 * A registry for {@link IAnnotationFactory} objects.
 * 
 * 
 * The registry is used to look up the {@link IAnnotationFactory} via type
 * names.
 * 
 */
public interface IAnnotationOutlet {
	/**
	 * The list of all available {@link IAnnotationFactory} objects. This is not
	 * the internal data structure, so you can not manipulate directly.
	 * 
	 * 
	 * @return The list of all available {@link IAnnotationFactory} instances.
	 */
	public IAnnotationFactory[] getAnnotationFactories();

	/**
	 * The {@link IAnnotationFactory} for the requested annotation type or null.
	 * 
	 * @param type
	 *            An annotation type.
	 * 
	 * @return The {@link IAnnotationFactory} for the requested annotation type
	 *         or null.
	 */
	public IAnnotationFactory lookupAnnotationFactory(COSName type);

	/**
	 * Register a new {@link IAnnotationFactory} object.
	 * 
	 * @param factory
	 *            The factory object to be registered.
	 */
	public void registerAnnotationFactory(IAnnotationFactory factory);

	/**
	 * Unregister a {@link IAnnotationFactory} object.
	 * 
	 * @param factory
	 *            The factory object to be deregistered.
	 */
	public void unregisterAnnotationFactory(IAnnotationFactory factory);

}