当前页面: 在线文档首页 > JBOSS Portal 2.6 API 英文版文档

Explode - JBOSS Portal 2.6 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.common.ant
Class Explode

java.lang.Object
  Task
      org.jboss.portal.common.ant.Explode

---

public class Explode

extends Task

Ant task that explode an archive.

Version:

$Revision: 5451 $

Author:

Julien Viet

See Also:

Serialized Form

---

Field Summary
private  java.lang.String	exclude           filename to exclude from decompression *
private static java.util.Set	extensions           Unzipped extensions.
private  java.io.File	file           The exploded file.
private  java.lang.String	name           The target optional name.
private  java.io.File	todir           The target directory.

 

Constructor Summary

Explode()

 

Method Summary
private static void	ensureDirExist(Explode explode, java.io.File dir)           When it returns the dir exists otherwise it throws a BuildException
void	execute()
static void	explode(Explode explode, java.lang.String name, java.util.zip.ZipInputStream zip, java.io.File todir, java.lang.String exclude)           Explode a zip stream into a directory.
void	explode(java.io.File file, java.io.File todir)
void	setExclude(java.lang.String exclude)
void	setFile(java.io.File file)
void	setName(java.lang.String name)
void	setTodir(java.io.File todir)

 

Methods inherited from class java.lang.Object

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

 

Field Detail

extensions

private static final java.util.Set extensions

Unzipped extensions.

---

file

private java.io.File file

The exploded file.

---

todir

private java.io.File todir

The target directory.

---

name

private java.lang.String name

The target optional name.

---

exclude

private java.lang.String exclude

filename to exclude from decompression *

Constructor Detail

Explode

public Explode()

Method Detail

setExclude

public void setExclude(java.lang.String exclude)

---

setFile

public void setFile(java.io.File file)

---

setTodir

public void setTodir(java.io.File todir)

---

setName

public void setName(java.lang.String name)

---

execute

public void execute()
             throws BuildException

Throws:

BuildException

---

explode

public void explode(java.io.File file,
                    java.io.File todir)
             throws BuildException,
                    DirException

Throws:

BuildException

DirException

---

explode

public static void explode(Explode explode,
                           java.lang.String name,
                           java.util.zip.ZipInputStream zip,
                           java.io.File todir,
                           java.lang.String exclude)
                    throws BuildException,
                           DirException

Explode a zip stream into a directory.

Parameters:

explode - used to log

name - the name of the created directory

zip - the zip stream will not be closed

todir - the parent directory

Throws:

BuildException

DirException

---

ensureDirExist

private static void ensureDirExist(Explode explode,
                                   java.io.File dir)
                            throws FileIsNotDirException,
                                   CannotCreateDirException

When it returns the dir exists otherwise it throws a BuildException

Throws:

FileIsNotDirException

CannotCreateDirException

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---