com.groupdocs.editor.htmlcss.resources.textual

Class TextResourceBase

java.lang.Object

com.groupdocs.editor.htmlcss.resources.textual.TextResourceBase

All Implemented Interfaces:

IAuxDisposable, IHtmlResource, IDisposable

Direct Known Subclasses:

CssText, XmlText

public abstract class TextResourceBase
extends Object
implements IHtmlResource

Base class for any supported text resource with text content and encoding

Field Summary

Fields

Modifier and Type	Field and Description
Event<EventHandler>	Disposed

Constructor Summary

Constructors

Constructor and Description
TextResourceBase(String name, InputStream binaryContent, Charset originalEncoding) Creates new text resource from specified byte stream and encoding
TextResourceBase(String name, String textualContent, Charset originalEncoding) Creates new text resource from specified textual content with encoding

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this text resource, disposing its content and making most methods and properties non-working.
boolean	equals(IHtmlResource other) Checks this instance with specified on equality.
InputStream	getByteContent() Returns content of this text resource as byte stream with original encoding
Charset	getEncoding() Returns encoding of this textual resource.
String	getFilenameWithExtension() Returns correct filename of this text resource, which consists of name and extension
String	getName() Returns name of this text resource without file extension
String	getTextContent() Returns content of this text resource as a standard string
abstract TextType	getType() In implementing type should return information about type of the text resource
boolean	isDisposed() Determines whether this text resource is disposed or not
void	save(String fullPathToFile) Saves this text resource to the specified file

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Disposed

public final Event<EventHandler> Disposed

Constructor Detail

TextResourceBase

public TextResourceBase(String name,
                        InputStream binaryContent,
                        Charset originalEncoding)

Creates new text resource from specified byte stream and encoding

Parameters:

name - Mandatory name of the resource, that serves as its unique identifier. Usually is a file name.

binaryContent - Binary content of a resource as a byte stream. Cannot be NULL, disposed, should be readable and seekable.

originalEncoding - Original encoding of the resource, cannot be NULL or empty

TextResourceBase

public TextResourceBase(String name,
                        String textualContent,
                        Charset originalEncoding)

Creates new text resource from specified textual content with encoding

Parameters:

name - Mandatory name of the resource, that serves as its unique identifier. Usually is a file name.

textualContent - Textual content of the resource, cannot be NULL or empty

originalEncoding - Original encoding of the resource, cannot be NULL or empty

Method Detail

dispose

public final void dispose()

Disposes this text resource, disposing its content and making most methods and properties non-working. Tolerant to multiple calls.

Specified by:

dispose in interface IDisposable

equals

public final boolean equals(IHtmlResource other)

Checks this instance with specified on equality.

Parameters:

other - Other HTML resource of unknown type, that is also presumable TextResourceBase inheritor

Returns:

Returns true if are equal, or false if are unequal

getByteContent

public final InputStream getByteContent()

Returns content of this text resource as byte stream with original encoding

Specified by:

getByteContent in interface IHtmlResource

Returns:

getEncoding

public final Charset getEncoding()

Returns encoding of this textual resource. Usually returns UTF-8.

Returns:

getFilenameWithExtension

public final String getFilenameWithExtension()

Returns correct filename of this text resource, which consists of name and extension

Specified by:

getFilenameWithExtension in interface IHtmlResource

Returns:

getName

public final String getName()

Returns name of this text resource without file extension

Specified by:

getName in interface IHtmlResource

Returns:

getTextContent

public final String getTextContent()

Returns content of this text resource as a standard string

Specified by:

getTextContent in interface IHtmlResource

Returns:

getType

public abstract TextType getType()

In implementing type should return information about type of the text resource

Specified by:

getType in interface IHtmlResource

Returns:

isDisposed

public final boolean isDisposed()

Determines whether this text resource is disposed or not

Specified by:

isDisposed in interface IAuxDisposable

Returns:

save

public final void save(String fullPathToFile)

Saves this text resource to the specified file

Specified by:

save in interface IHtmlResource

Parameters:

fullPathToFile - Full path to the file, which will be created or rewritten if already exists