org.jamplate.impl.model

Class PseudoDocument

java.lang.Object

org.jamplate.impl.model.PseudoDocument

All Implemented Interfaces:

java.io.Serializable, Document

public class PseudoDocument
extends java.lang.Object
implements Document

A pseudo document that get made programmatically.

Since:

0.2.0 ~2021.01.13

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull java.lang.CharSequence	content The content of this document.
protected @NotNull java.lang.String	identifier The identifier of this document.

Constructor Summary

Constructors

Constructor and Description
PseudoDocument() Construct a new pseudo document that has no content neither can be identified.
PseudoDocument(@NotNull java.lang.CharSequence content) Construct a new pseudo document that have the given content.
PseudoDocument(@NotNull java.lang.String identifier, @NotNull java.lang.CharSequence content) Construct a new pseudo document that have the given content and be identified with the given identifier.

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable java.lang.Object object) Determines if the given object equals this document or not.
int	hashCode() Calculate the hash code of this document.
@NotNull java.io.InputStream	openInputStream() Open a new input-stream that reads the content of this document.
@NotNull java.io.Reader	openReader() Open a new reader that reads the content of this document.
@NotNull java.lang.CharSequence	read() Read the content of this document.
@NotNull java.lang.String	toString() Returns a string representation of this document.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jamplate.model.Document

openInputStream, openReader, read

Field Detail

content

@NotNull
protected final @NotNull java.lang.CharSequence content

The content of this document.

Since:

0.2.0 ~2021.01.13

identifier

@NotNull
protected final @NotNull java.lang.String identifier

The identifier of this document.

Since:

0.2.0 ~2021.02.17

Constructor Detail

PseudoDocument

public PseudoDocument()

Construct a new pseudo document that has no content neither can be identified.

Since:

0.2.0 ~2021.02.19

PseudoDocument

public PseudoDocument(@NotNull
                      @NotNull java.lang.CharSequence content)

Construct a new pseudo document that have the given content. The identifier of the constructed document will be the string in hex of the identitiy hash code of the given content.
Important Note: do not provide modifiable content (such as StringBuilder). For the sake of performance and compatibility, this class will simply give its content instance to anyone requests it. So, due to that. The provided content might get changed in value while it suppose to be immutable.

Parameters:

content - the content of the constructed pseudo content.

Throws:

java.lang.NullPointerException - if the given content is null.

Since:

0.2.0 ~2021.01.13

PseudoDocument

public PseudoDocument(@NotNull
                      @NotNull java.lang.String identifier,
                      @NotNull
                      @NotNull java.lang.CharSequence content)

Construct a new pseudo document that have the given content and be identified with the given identifier.
Important Note: do not provide modifiable content (such as StringBuilder). For the sake of performance and compatibility, this class will simply give its content instance to anyone requests it. So, due to that. The provided content might get changed in value while it suppose to be immutable.

Parameters:

identifier - the identity of the constructed document.

content - the content of the constructed pseudo content.

Throws:

java.lang.NullPointerException - if the given identifier or content is null.

Since:

0.2.0 ~2021.01.13

Method Detail

equals

public boolean equals(@Nullable
                      @Nullable java.lang.Object object)

Description copied from interface: Document

Determines if the given object equals this document or not. An object equals a document when that object is pointing to the same source as this document. (regardless of its content, assuming the user is honest and does not provide two documents with same source but from different origins or have different content)

     equals = object instanceof Document &&
                        this.toString().equals(object.toString())
 

Specified by:

equals in interface Document

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to be matched.

Returns:

true, if the given object is a document and equals this document.

hashCode

public int hashCode()

Description copied from interface: Document

Calculate the hash code of this document. The hash code of a document is the hashes of the variables related to its source (like drive, path, name, module, etc..). The implementer is totally free to implement its own algorithm. As long as it is a result from calculating uniq variables about its source.

     hashCode = <SourceUniqIdentifiers>
 

Specified by:

hashCode in interface Document

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this document.

openInputStream

@NotNull
public @NotNull java.io.InputStream openInputStream()

Description copied from interface: Document

Open a new input-stream that reads the content of this document.

Specified by:

openInputStream in interface Document

Returns:

a new input-stream that reads the content of this document.

openReader

@NotNull
public @NotNull java.io.Reader openReader()

Description copied from interface: Document

Open a new reader that reads the content of this document.

Specified by:

openReader in interface Document

Returns:

a new reader that reads the content of this document.

read

@NotNull
public @NotNull java.lang.CharSequence read()

Description copied from interface: Document

Read the content of this document.

Specified by:

read in interface Document

Returns:

the content of this document. (unmodifiable view)

toString

@NotNull
public @NotNull java.lang.String toString()

Description copied from interface: Document

Returns a string representation of this document. The string representation of a document is the name of its source.

     toString = <SourceUniqName>
 

Specified by:

toString in interface Document

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this document.