01: /*
02: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of Substance Kirill Grouchnikov nor the names of
15: * its contributors may be used to endorse or promote products derived
16: * from this software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30: package org.jvnet.substance.plugin;
31:
32: import java.util.Set;
33:
34: import org.jvnet.lafplugin.LafPlugin;
35: import org.jvnet.substance.watermark.WatermarkInfo;
36:
37: /**
38: * Plugin for watermark extension. This class is <b>for internal use only</b>.
39: *
40: * @author Kirill Grouchnikov
41: */
42: public interface SubstanceWatermarkPlugin extends LafPlugin {
43: /**
44: * XML tag that contains fully-qualified class name of watermark plugin
45: * class.
46: */
47: public static final String TAG_WATERMARK_PLUGIN_CLASS = "watermark-plugin-class";
48:
49: /**
50: * Returns information on all available watermarks in <code>this</code>
51: * plugin.
52: *
53: * @return Information on all available watermarks in <code>this</code>
54: * plugin.
55: */
56: public Set<WatermarkInfo> getWatermarks();
57:
58: /**
59: * Returns the class name of the default watermark.
60: *
61: * @return The class name of the default watermark.
62: */
63: public String getDefaultWatermarkClassName();
64: }
|