mirror of https://github.com/dspinellis/UMLGraph
58 lines
1.6 KiB
Java
58 lines
1.6 KiB
Java
/*
|
|
* Contibuted by Andrea Aime
|
|
* (C) Copyright 2002-2005 Diomidis Spinellis
|
|
*
|
|
* Permission to use, copy, and distribute this software and its
|
|
* documentation for any purpose and without fee is hereby granted,
|
|
* provided that the above copyright notice appear in all copies and that
|
|
* both that copyright notice and this permission notice appear in
|
|
* supporting documentation.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|
|
*
|
|
*
|
|
*/
|
|
|
|
package org.umlgraph.doclet;
|
|
|
|
import com.sun.javadoc.ClassDoc;
|
|
|
|
/**
|
|
* A factory class that builds Options object for general use or for a
|
|
* specific class
|
|
*/
|
|
public interface OptionProvider {
|
|
/**
|
|
* Returns the options for the specified class.
|
|
*/
|
|
public Options getOptionsFor(ClassDoc cd);
|
|
|
|
/**
|
|
* Returns the options for the specified class.
|
|
*/
|
|
public Options getOptionsFor(String name);
|
|
|
|
/**
|
|
* Returns the global options (the class independent definition)
|
|
*/
|
|
public Options getGlobalOptions();
|
|
|
|
/**
|
|
* Gets a base Options and applies the overrides for the specified class
|
|
*/
|
|
public void overrideForClass(Options opt, ClassDoc cd);
|
|
|
|
/**
|
|
* Gets a base Options and applies the overrides for the specified class
|
|
*/
|
|
public void overrideForClass(Options opt, String className);
|
|
|
|
/**
|
|
* Returns user displayable name for this option provider.
|
|
* <p>Will be used to provide progress feedback on the console
|
|
*/
|
|
public String getDisplayName();
|
|
}
|