com.atlassian.gadgets.publisher.internal
Interface PublishedGadgetSpecWriter
- All Known Implementing Classes:
- PublishedGadgetSpecStoreImpl
public interface PublishedGadgetSpecWriter
Writes XML gadget spec files from an underlying store to arbitrary output streams.
Method Summary |
void |
writeGadgetSpecTo(String pluginKey,
String location,
OutputStream outputStream)
Writes the gadget spec from the specified plugin, with the specified resource location within the plugin, to the
specified OutputStream . |
writeGadgetSpecTo
void writeGadgetSpecTo(String pluginKey,
String location,
OutputStream outputStream)
throws IOException,
PublishedGadgetSpecNotFoundException
- Writes the gadget spec from the specified plugin, with the specified resource location within the plugin, to the
specified
OutputStream
. Output will be buffered internally, so there is no need for the calling code to
wrap the OutputStream
with a BufferedOutputStream
.
- Parameters:
pluginKey
- the plugin key of the Plugin
that contains the gadget spec to
store. Must not be null
, or a NullPointerException
will be thrown.location
- the location of the gadget spec XML file resource within the plugin. Must not be null
, or a NullPointerException
will be thrown.outputStream
- the OutputStream
to write the gadget spec XML to. Must not be null
, or a
NullPointerException
will be thrown.
- Throws:
IOException
- if an error occurs in I/O processing
NullPointerException
- if any argument is null
PublishedGadgetSpecNotFoundException
- if no resource could be found at the specified path
Copyright © 2009 Atlassian. All Rights Reserved.