csbase.logic

Class FileInfo

java.lang.Object

csbase.logic.FileInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileInfo>

public class FileInfo
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<FileInfo>

Author:

Tecgraf / PUC-Rio Classe usada para representar um arquivo.
Ela contém as informações básicas de um arquivo como nome, pai, filhos e se é um diretório e pode ser serializada, permitindo passar essas informações entre cliente e servidor.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileInfo(java.io.File file) Construtor.
FileInfo(java.lang.String[] path, java.lang.String name, boolean isDirectory) Construtor.
FileInfo(java.lang.String name, boolean isDirectory) Construtor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addChild(FileInfo child) Adiciona um FileInfo representando um filho do arquivo e se põe como pai daquela instância.
int	compareTo(FileInfo o)
static java.util.List<FileInfo>	createFilesInfo(java.io.File dir) Cria uma lista de FileInfo a partir dos arquivos presentes no diretório passado como argumento.
boolean	equals(java.lang.Object obj)
java.util.List<FileInfo>	getChildren() Obtém uma lista de FileInfo representando os arquivos presentes no diretório representado por esta instância.
java.lang.String	getName() Obtém o nome do arquivo representado por esta instância.
FileInfo	getParent() Obtém uma instância de FileInfo representando o diretório em que o arquivo representado pro esta instância se encontra.
java.lang.String	getPath() Obtém o caminho relativo até este executável.
java.lang.String[]	getPathAsArray() Obtém o caminho relativo até este executável.
int	hashCode()
boolean	isDirectory() Indica se esta instância representa um diretório.
static boolean	isNameValid(java.lang.String name) Checa se o nome do arquivo é válido. O nome do arquivo NÃO deve: Ser nulo. Ser igual ao nome do diretório do controle de versão.
java.lang.String	toString() Obtém a representação desta instância na forma de uma String. Essa instância é representada como uma String, através de seu nome.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInfo

public FileInfo(java.lang.String[] path,
        java.lang.String name,
        boolean isDirectory)

Construtor.

Parameters:

path - caminho de diretórios até o arquivo sendo representado.

name - Nome do arquivo que esta instância irá representar.

isDirectory - true se o arquivo representado por esta instância é um diretório.

Throws:

java.lang.IllegalArgumentException - se o nome do arquivo ou de algum de seus diretórios presente no path for inválido.

See Also:

isNameValid(String)

FileInfo

public FileInfo(java.io.File file)

Construtor.

Parameters:

file - arquivo a ser representado por esta instância.

Throws:

java.lang.IllegalArgumentException - se o nome do arquivo for inválido.

See Also:

isNameValid(String)

FileInfo

public FileInfo(java.lang.String name,
        boolean isDirectory)

Construtor.

Parameters:

name - Nome do arquivo que esta instância irá representar.

isDirectory - true se o arquivo representado por esta instância é um diretório.

Throws:

java.lang.IllegalArgumentException - se o nome do arquivo for inválido.

See Also:

isNameValid(String)

Method Detail

createFilesInfo

public static java.util.List<FileInfo> createFilesInfo(java.io.File dir)

Cria uma lista de FileInfo a partir dos arquivos presentes no diretório passado como argumento.

O diretório não será levado em consideração e assim não será criado um representando ele como pai dos demais. Caso este seja o seu objetivo, basta criar um FileInfo do diretório a partir do FileInfo(File) e pedir a lista de filhos dele através do método getChildren().

Obs. Arquivos com nome inválido serão ignorados.

Parameters:

dir - diretório que detêm os arquivos a serem representados como instâncias de

Returns:

uma lista de FileInfo a partir dos arquivos presentes no diretório passado como argumento.

See Also:

isNameValid(String)

isNameValid

public static boolean isNameValid(java.lang.String name)

Checa se o nome do arquivo é válido.
O nome do arquivo NÃO deve:

1. Ser nulo.
2. Ser igual ao nome do diretório do controle de versão.

Parameters:

name - nome do arquivo a ser checado.

Returns:

true se o nome for válido para criar um FileInfo.

getName

public java.lang.String getName()

Obtém o nome do arquivo representado por esta instância.

Returns:

o nome do arquivo representado por esta instância.

getParent

public FileInfo getParent()

Obtém uma instância de FileInfo representando o diretório em que o arquivo representado pro esta instância se encontra.

Returns:

uma instância de FileInfo representando o diretório aonde o arquivo se encontra.

getChildren

public java.util.List<FileInfo> getChildren()

Obtém uma lista de FileInfo representando os arquivos presentes no diretório representado por esta instância. Caso esta instância não represente um diretório uma lista vazia será retornada.
Obs. A lista retornada não pode ser modificada.

Returns:

uma lista de FileInfo representando os arquivos presentes no diretório representado por esta instância. Caso esta instância não represente um diretório uma lista vazia será retornada.
Obs. A lista retornada não pode ser modificada.

addChild

public boolean addChild(FileInfo child)

Adiciona um FileInfo representando um filho do arquivo e se põe como pai daquela instância.

Parameters:

child - representação do filho do arquivo.

Returns:

true se este representa um diretório e se o filho foi inserido com sucesso.

See Also:

setParent(FileInfo)

isDirectory

public boolean isDirectory()

Indica se esta instância representa um diretório.

Returns:

true se esta instância representar um diretório.

getPath

public java.lang.String getPath()

Obtém o caminho relativo até este executável.

Returns:

o caminho relativo até este executável.

getPathAsArray

public java.lang.String[] getPathAsArray()

Obtém o caminho relativo até este executável.

Returns:

o caminho relativo até este executável.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(FileInfo o)

Specified by:

compareTo in interface java.lang.Comparable<FileInfo>

toString

public java.lang.String toString()

Obtém a representação desta instância na forma de uma String.
Essa instância é representada como uma String, através de seu nome.

Overrides:

toString in class java.lang.Object

Returns:

a representação desta instância na forma de uma String.