org.jamplate.model

Interface Document

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FileDocument, PseudoDocument

public interface Document
extends java.io.Serializable

An interface that abstracts the functionality required to deal with source-code files.

Since:

0.2.0 ~2021.01.13

Version:

0.2.0

Author:

LSafer

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.
default @NotNull java.io.InputStream	openInputStream(@NotNull Reference reference) Open a new input-stream that reads the content at the given reference in this document.
@NotNull java.io.Reader	openReader() Open a new reader that reads the content of this document.
default @NotNull java.io.Reader	openReader(@NotNull Reference reference) Open a new reader that reads the content at the given reference in this document.
@NotNull java.lang.CharSequence	read() Read the content of this document.
default @NotNull java.lang.CharSequence	read(@NotNull Reference reference) Read the content at the given reference in this document.
@NotNull java.lang.String	toString() Returns a string representation of this document.

Method Detail

openInputStream

@NotNull
 @Contract(pure=true)
default @NotNull java.io.InputStream openInputStream(@NotNull
                                                                                      @NotNull Reference reference)
                                                                               throws java.io.IOException

Open a new input-stream that reads the content at the given reference in this document.

Parameters:

reference - the range to be read.

Returns:

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

Throws:

java.io.IOException - if any I/O exception occurs.

DocumentNotFoundException - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13

openReader

@NotNull
 @Contract(pure=true)
default @NotNull java.io.Reader openReader(@NotNull
                                                                            @NotNull Reference reference)
                                                                     throws java.io.IOException

Open a new reader that reads the content at the given reference in this document.

Parameters:

reference - the range to be read.

Returns:

a new reader that reads the content of this document.

Throws:

java.io.IOException - if any I/O exception occurs. (optional)

DocumentNotFoundException - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13

read

@NotNull
 @Contract(pure=true)
default @NotNull java.lang.CharSequence read(@NotNull
                                                                              @NotNull Reference reference)

Read the content at the given reference in this document.

Parameters:

reference - the range to be read.

Returns:

the content of this document. (unmodifiable view)

Throws:

java.io.IOError - if any I/O exception occurs. (optional)

DocumentNotFoundError - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13

equals

@Contract(value="null->false",
          pure=true)
boolean equals(@Nullable
                                                                     @Nullable java.lang.Object object)

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())
 

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.

Since:

0.2.0 ~2021.01.13

hashCode

@Contract(pure=true)
int hashCode()

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>
 

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code of this document.

Since:

0.2.0 ~2021.01.13

toString

@NotNull
 @Contract(pure=true)
@NotNull java.lang.String toString()

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

     toString = <SourceUniqName>
 

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this document.

Since:

0.2.0 ~2021.01.13

openInputStream

@NotNull
 @Contract(pure=true)
@NotNull java.io.InputStream openInputStream()
                                                                       throws java.io.IOException

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

Returns:

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

Throws:

java.io.IOException - if any I/O exception occurs.

DocumentNotFoundException - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13

openReader

@NotNull
 @Contract(pure=true)
@NotNull java.io.Reader openReader()
                                                             throws java.io.IOException

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

Returns:

a new reader that reads the content of this document.

Throws:

java.io.IOException - if any I/O exception occurs. (optional)

DocumentNotFoundException - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13

read

@NotNull
 @Contract(pure=true)
@NotNull java.lang.CharSequence read()

Read the content of this document.

Returns:

the content of this document. (unmodifiable view)

Throws:

java.io.IOError - if any I/O exception occurs. (optional)

DocumentNotFoundError - if this document is not available for reading.

Since:

0.2.0 ~2021.01.13