org.jamplate.impl.model

Class FileDocument

java.lang.Object

org.jamplate.impl.model.FileDocument

All Implemented Interfaces:

java.io.Serializable, Document

public class FileDocument
extends java.lang.Object
implements Document

A document that delegates to a File.

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 @Nullable java.lang.String	content The content of this document.
protected @NotNull java.io.File	file The file of this file document.

Constructor Summary

Constructors

Constructor and Description
FileDocument(@NotNull java.io.File file) Construct a new document for the given file.
FileDocument(@NotNull java.lang.String filename) Construct a new document for the file with the given filename.

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.
static @NotNull Document[]	hierarchy(@NotNull java.io.File file) Return an array of all the document in the hierarchy of the given file (including itself).
static @NotNull java.util.Set<Document>	hierarchySet(@NotNull java.io.File file) Return a set of all the document in the hierarchy of the given file (including itself).
@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

file

@NotNull
protected final @NotNull java.io.File file

The file of this file document.

Since:

0.2.0 ~2021.01.13

content

@Nullable
protected @Nullable java.lang.String content

The content of this document. (cached, lazily initialized)

Since:

0.2.0 ~2021.01.16

Constructor Detail

FileDocument

public FileDocument(@NotNull
                    @NotNull java.lang.String filename)

Construct a new document for the file with the given filename.

Parameters:

filename - the name of the file for the constructed document.

Throws:

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

Since:

0.2.0 ~2021.01.13

FileDocument

public FileDocument(@NotNull
                    @NotNull java.io.File file)

Construct a new document for the given file.

Parameters:

file - the file for the constructed document.

Throws:

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

Since:

0.2.0 ~2021.01.13

Method Detail

hierarchy

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull Document[] hierarchy(@NotNull
                                                                                                        @NotNull java.io.File file)

Return an array of all the document in the hierarchy of the given file (including itself).

Parameters:

file - the file to collect the documents in its hierarchy (including itself).

Returns:

an array of all the documents in the hierarchy of the given file.

Throws:

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

Since:

0.2.0 ~2021.05.31

hierarchySet

@NotNull
 @Contract(value="_->new",
          pure=true)
public static @NotNull java.util.Set<Document> hierarchySet(@NotNull
                                                                                                                        @NotNull java.io.File file)

Return a set of all the document in the hierarchy of the given file (including itself).

Parameters:

file - the file to collect the documents in its hierarchy (including itself).

Returns:

a set of all the documents in the hierarchy of the given file.

Throws:

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

Since:

0.2.0 ~2021.05.31

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()
                                                       throws java.io.FileNotFoundException,
                                                              DocumentNotFoundException

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.

Throws:

DocumentNotFoundException - if this document is not available for reading.

java.io.FileNotFoundException

openReader

@NotNull
public @NotNull java.io.Reader openReader()
                                             throws java.io.FileNotFoundException,
                                                    DocumentNotFoundException

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.

Throws:

DocumentNotFoundException - if this document is not available for reading.

java.io.FileNotFoundException

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.