blob: 6d1419ec0db4d5c5a51ef68c72214604d5415386 [file] [log] [blame]
/*
* Copyright 2002-2005 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.vfs.provider.tar;
import org.apache.commons.compress.tar.TarEntry;
import org.apache.commons.vfs.FileName;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.FileSystemException;
import org.apache.commons.vfs.FileType;
import org.apache.commons.vfs.provider.AbstractFileObject;
import java.io.InputStream;
import java.util.HashSet;
/**
* A file in a Tar file system.
*/
public class TarFileObject
extends AbstractFileObject
implements FileObject
{
private final HashSet children = new HashSet();
private final TarFileSystem fs;
protected TarEntry entry;
private FileType type;
protected TarFileObject(FileName name,
TarEntry entry,
TarFileSystem fs,
boolean tarExists) throws FileSystemException
{
super(name, fs);
this.fs = fs;
setTarEntry(entry);
if (!tarExists)
{
type = FileType.IMAGINARY;
}
}
/**
* Sets the details for this file object.
*/
protected void setTarEntry(final TarEntry entry)
{
if (this.entry != null)
{
return;
}
if ((entry == null) || (entry.isDirectory()))
{
type = FileType.FOLDER;
}
else
{
type = FileType.FILE;
}
this.entry = entry;
}
/**
* Attaches a child
*/
protected void attachChild(FileName childName)
{
children.add(childName.getBaseName());
}
/**
* Returns true if this file is read-only.
*/
public boolean isWriteable()
{
return false;
}
/**
* Returns the file's type.
*/
protected FileType doGetType()
{
return type;
}
/**
* Lists the children of the file.
*/
protected String[] doListChildren()
{
return (String[]) children.toArray(new String[children.size()]);
}
/**
* Returns the size of the file content (in bytes). Is only called if
* {@link #doGetType} returns {@link FileType#FILE}.
*/
protected long doGetContentSize()
{
if (entry == null)
{
return 0;
}
return entry.getSize();
}
/**
* Returns the last modified time of this file.
*/
protected long doGetLastModifiedTime() throws Exception
{
if (entry == null)
{
return 0;
}
return entry.getModTime().getTime();
}
/**
* Creates an input stream to read the file content from. Is only called
* if {@link #doGetType} returns {@link FileType#FILE}. The input stream
* returned by this method is guaranteed to be closed before this
* method is called again.
*/
protected InputStream doGetInputStream() throws Exception
{
return fs.getInputStream(entry);
}
}