org.jboss.forge.addon.resource

Interface WriteableResource<T extends WriteableResource<T,R>,R>

Type Parameters:

T - The Resource type that implements this interface.

All Superinterfaces:

Faceted<ResourceFacet>, Resource<R>

All Known Subinterfaces:

DirectoryResource, FileResource<T>, GitIgnoreResource, JavaResource, JsonResource, MavenModelResource, ScriptFileResource, XMLResource, YamlResource, ZipFileResource

All Known Implementing Classes:

AbstractFileResource, AbstractJsonResource, AbstractXMLResource, AbstractYamlResource, ScriptFileResourceImpl

public interface WriteableResource<T extends WriteableResource<T,R>,R>
extends Resource<R>

A WriteableResource allows its contents to be changed

Author:

George Gastaldi, Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
OutputStream	getResourceOutputStream() Returns the OutputStream for this WriteableResource
OutputStream	getResourceOutputStream(boolean append) Returns the OutputStream for this WriteableResource
T	setContents(char[] data) Set the contents of this WriteableResource to the given character array using UTF-8 encoding.
T	setContents(char[] data, Charset charset) Set the contents of this WriteableResource to the given character array using the specified encoding.
T	setContents(InputStream data) Set the contents of this WriteableResource to the contents of the given InputStream.
T	setContents(String data) Set the contents of this WriteableResource to the given String using UTF-8 encoding.
T	setContents(String data, Charset charset) Set the contents of this WriteableResource to the given String using the specified encoding.

Methods inherited from interface org.jboss.forge.addon.resource.Resource

as, createFrom, delete, delete, exists, getChild, getContents, getContents, getFullyQualifiedName, getName, getParent, getResourceFactory, getResourceInputStream, getUnderlyingResourceObject, listResources, listResources, reify, resolveChildren

Methods inherited from interface org.jboss.forge.addon.facets.Faceted

getFacet, getFacetAsOptional, getFacets, getFacets, hasAllFacets, hasAllFacets, hasFacet, supports

Method Detail

setContents

T setContents(String data)

Set the contents of this WriteableResource to the given String using UTF-8 encoding.

setContents

T setContents(String data,
              Charset charset)

Set the contents of this WriteableResource to the given String using the specified encoding.

setContents

T setContents(char[] data)

Set the contents of this WriteableResource to the given character array using UTF-8 encoding.

setContents

T setContents(char[] data,
              Charset charset)

Set the contents of this WriteableResource to the given character array using the specified encoding.

setContents

T setContents(InputStream data)

Set the contents of this WriteableResource to the contents of the given InputStream.

getResourceOutputStream

OutputStream getResourceOutputStream()

Returns the OutputStream for this WriteableResource

getResourceOutputStream

OutputStream getResourceOutputStream(boolean append)

Returns the OutputStream for this WriteableResource

Parameters:

append - true if the OutputStream should append to the existing contents, false if it should overwrite