com.jbbres.lib.actions.files
Class ActionsCollectionFile

java.lang.Object
  extended by java.io.File
      extended by com.jbbres.lib.actions.files.ActionsCollectionFile
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<java.io.File>

public class ActionsCollectionFile
extends java.io.File

Represents an Action(s) collection (.actc) file. This class is for internal use only.

Action(s) collection files contains one or multiple Element objects. Collection files are basically Java JAR files with additional information in the manifest file. These additional information are used iddentify the Elements within the file.

An instance of this class represents a collection file, but does not provide specific methods to interact with the file content. Collection files are internal to Action(s) and no API for accessing them is provided.

ActionsCollectionFile extends java.io.File and inherits all its functionalities.

Since:
1.0.0
Version:
1.0.1
Author:
Jean-Baptiste Bres
See Also:
Serialized Form

Field Summary
static java.lang.String MIME_DESCRIPTION
          The MIME type description
static java.lang.String MIME_EXTENSION
          Deprecated. since 1.0.1 - The MIME_EXTENSIONS variable now contains all the accepted extensions for collection files.
static java.lang.String MIME_EXTENSION_ACTC
          The actc file extension.
static java.lang.String MIME_EXTENSION_JAR
          The jar file extension.
static java.lang.String[] MIME_EXTENSIONS
          List all the extensions that can contain a collection.
static java.lang.String MIME_TYPE
          The MIME type.
 
Fields inherited from class java.io.File
pathSeparator, pathSeparatorChar, separator, separatorChar
 
Constructor Summary
ActionsCollectionFile(java.io.File file)
          Creates a new ActionsCollectionFile instance by converting the pathname string of the given file into an abstract pathname.
ActionsCollectionFile(java.io.File parent, java.lang.String child)
          Creates a new ActionsCollectionFile instance from a parent abstract pathname and a child pathname string.
ActionsCollectionFile(java.lang.String pathname)
          Creates a new ActionsCollectionFile instance by converting the given pathname string into an abstract pathname.
ActionsCollectionFile(java.lang.String parent, java.lang.String child)
          Creates a new ActionsCollectionFile instance from a parent pathname string and a child pathname string.
ActionsCollectionFile(java.net.URI uri)
          Creates a new ActionsCollectionFile instance by converting the given file: URI into an abstract pathname.
 
Method Summary
static com.jbbres.lib.file.MimeType getMimeType()
          Returns the MimeType object associated to this type of file.
 
Methods inherited from class java.io.File
canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

MIME_DESCRIPTION

public static java.lang.String MIME_DESCRIPTION
The MIME type description


MIME_EXTENSION_ACTC

public static java.lang.String MIME_EXTENSION_ACTC
The actc file extension.


MIME_EXTENSION_JAR

public static java.lang.String MIME_EXTENSION_JAR
The jar file extension.


MIME_EXTENSIONS

public static java.lang.String[] MIME_EXTENSIONS
List all the extensions that can contain a collection.


MIME_TYPE

public static java.lang.String MIME_TYPE
The MIME type.


MIME_EXTENSION

@Deprecated
public static java.lang.String MIME_EXTENSION
Deprecated. since 1.0.1 - The MIME_EXTENSIONS variable now contains all the accepted extensions for collection files.
The actc default file extension.

Constructor Detail

ActionsCollectionFile

public ActionsCollectionFile(java.io.File file)
Creates a new ActionsCollectionFile instance by converting the pathname string of the given file into an abstract pathname. If the given string is the empty string, then the result is the empty abstract pathname.

Parameters:
file - - a file.

ActionsCollectionFile

public ActionsCollectionFile(java.net.URI uri)
Creates a new ActionsCollectionFile instance by converting the given file: URI into an abstract pathname.

The exact form of a file: URI is system-dependent, hence the transformation performed by this constructor is also system-dependent.

For a given abstract pathname f it is guaranteed that
new File( f.toURI()).equals( f.getAbsoluteFile())
so long as the original abstract pathname, the URI, and the new abstract pathname are all created in (possibly different invocations of) the same Java virtual machine. This relationship typically does not hold, however, when a file: URI that is created in a virtual machine on one operating system is converted into an abstract pathname in a virtual machine on a different operating system.

Parameters:
uri - - - An absolute, hierarchical URI with a scheme equal to "file", a non-empty path component, and undefined authority, query, and fragment components

ActionsCollectionFile

public ActionsCollectionFile(java.lang.String parent,
                             java.lang.String child)
Creates a new ActionsCollectionFile instance from a parent pathname string and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty string then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.

Parameters:
parent - - The parent pathname string
child - - The child pathname string

ActionsCollectionFile

public ActionsCollectionFile(java.io.File parent,
                             java.lang.String child)
Creates a new ActionsCollectionFile instance from a parent abstract pathname and a child pathname string.

If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string.

Otherwise the parent abstract pathname is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then it is converted into a relative pathname in a system-dependent way. If parent is the empty abstract pathname then the new File instance is created by converting child into an abstract pathname and resolving the result against a system-dependent default directory. Otherwise each pathname string is converted into an abstract pathname and the child abstract pathname is resolved against the parent.

Parameters:
parent - - The parent abstract pathname
child - - The child pathname string

ActionsCollectionFile

public ActionsCollectionFile(java.lang.String pathname)
Creates a new ActionsCollectionFile instance by converting the given pathname string into an abstract pathname. If the given string is the empty string, then the result is the empty abstract pathname.

Parameters:
pathname - - A pathname string
Method Detail

getMimeType

public static com.jbbres.lib.file.MimeType getMimeType()
Returns the MimeType object associated to this type of file.

Returns:
the MimeType associated to this type of file.


To file bugs or suggest feature enhancements, visit the app.jbbres.com Bug Reporter website.

Additional documentation available online at http://app.jbbres.com/actions/developers.

Copyright � 2009-2011 app.jbbres.com. All Rights Reserved.