net.sourceforge.javadpkg.plugin.impl

Class FileSystemNodeInfo

java.lang.Object

net.sourceforge.javadpkg.plugin.impl.FileSystemNodeInfo

public class FileSystemNodeInfo
extends Object

The additional information of the FileSystemNode used by the DataConfigurationParserImpl and the DataFileSystemNodeVisitor class.

Version:

1.0, 19.05.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
FileSystemNodeInfo(FileInfo source, boolean process, String encoding) Creates optional parameters.

Method Summary

Modifier and Type	Method and Description
String	getEncoding() Returns the encoding for the processing.
FileInfo	getSource() Returns the information about the source file.
boolean	isProcess() Returns the flag if the file should be processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemNodeInfo

public FileSystemNodeInfo(FileInfo source,
                          boolean process,
                          String encoding)

Creates optional parameters.

Parameters:

source - The information about the source file.

process - The flag if the file should be processed.

encoding - The encoding for the processing (optional).

Throws:

IllegalArgumentException - If any of the non-optional parameters are null.

Method Detail

getSource

public FileInfo getSource()

Returns the information about the source file.

Returns:

The file information.

isProcess

public boolean isProcess()

Returns the flag if the file should be processed.

Returns:

The flag: true, if the file should be processed, false otherwise.

See Also:

getEncoding()

getEncoding

public String getEncoding()

Returns the encoding for the processing.

This flag has only an effect if this node should be processed.

Returns:

The encoding or null, if the default encoding should be used.

See Also:

isProcess()