de.schlichtherle.io.ArchiveEntryMetaData Maven / Gradle / Ivy
/*
* Copyright (C) 2006-2010 Schlichtherle IT Services
*
* 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 de.schlichtherle.io;
import de.schlichtherle.io.archive.*;
import de.schlichtherle.io.archive.spi.*;
import java.io.*;
import java.util.*;
import javax.swing.Icon;
/**
* This class is not intended for public use!
* It's only public for technical reasons and may get renamed or entirely
* disappear without notice.
*
* Annotates an {@link ArchiveEntry} with the fields and methods required to
* implement the concept of a directory.
*
* @author Christian Schlichtherle
* @version $Id: ArchiveEntryMetaData.java 06f3ba684701 2010/11/04 01:15:55 christian $
* @since TrueZIP 6.0
*/
public class ArchiveEntryMetaData {
/**
* This thread local variable returns an {@link ArrayList} which is used
* as a temporary buffer to implement filtered list methods.
*/
private static final ThreadLocal threadLocal = new ThreadLocal() {
protected Object initialValue() {
return new ArrayList(64);
}
};
/**
* If the entry from which this object has been created represents a
* directory, then this is a valid reference to a set of Strings,
* representing the children names.
* Otherwise this field is initialized with {@code null}.
*/
final Set children;
/**
* A package private constructor.
* Used by the factory in this package only.
*/
ArchiveEntryMetaData(final ArchiveEntry entry) {
this.children = entry.isDirectory() ? new LinkedHashSet() : null;
}
/**
* Returns the names of the members in this directory in a newly
* created array. The returned array is not sorted.
* This is the most efficient list method.
*
* @throws NullPointerException If the entry from which this object has
* been created is not a directory.
*/
String[] list() {
final String[] list = new String[children.size()];
children.toArray(list);
return list;
}
/**
* Returns the names of the members in this directory which are
* accepted by {@code filenameFilter} in a newly created array.
* {@code dir} is used as the directory argument for the
* {@code filenameFilter}. The returned array is not sorted.
*
* @param filenameFilter a valid object - must not be {@code null}.
* @param dir the directory represented as a File object.
*
* @throws NullPointerException If the entry from which this object has
* been created is not a directory.
*/
String[] list(
final FilenameFilter filenameFilter,
final File dir) {
final List filteredList = (List) threadLocal.get();
assert filteredList.isEmpty();
try {
for (final Iterator i = children.iterator(); i.hasNext(); ) {
final String child = (String) i.next();
if (filenameFilter.accept(dir, child))
filteredList.add(child);
}
final String[] list = new String[filteredList.size()];
filteredList.toArray(list);
return list;
} finally {
filteredList.clear(); // support garbage collection of zip controllers!
}
}
/**
* Returns {@code File} objects for the members in this directory
* which are accepted by {@code filenameFilter} in a newly created
* array.
* {@code dir} is used as the directory argument for the
* {@code filenameFilter}. The returned array is not sorted.
*
* @param filenameFilter may be {@code null} to accept all members.
* @param dir the directory represented as a File object.
*
* @throws NullPointerException If the entry from which this object has
* been created is not a directory.
*/
File[] listFiles(
FilenameFilter filenameFilter,
final File dir,
final FileFactory factory) {
final List filteredList = (List) threadLocal.get();
assert filteredList.isEmpty();
try {
for (final Iterator i = children.iterator(); i.hasNext(); ) {
final String child = (String) i.next();
if (filenameFilter == null
|| filenameFilter.accept(dir, child))
filteredList.add(factory.createFile(dir, child));
}
final File[] list = new File[filteredList.size()];
filteredList.toArray(list);
return list;
} finally {
filteredList.clear(); // support garbage collection of zip controllers!
}
}
/**
* Returns {@code File} objects for the members in this directory
* which are accepted by {@code filenameFilter} in a newly created
* array.
* {@code dir} is used as the directory argument for the
* {@code filenameFilter}. The returned array is not sorted.
*
* @param fileFilter may be {@code null} to accept all members.
* @param dir the directory represented as a File object.
*
* @throws NullPointerException If the entry from which this object has
* been created is not a directory.
*/
File[] listFiles(
final FileFilter fileFilter,
final File dir,
final FileFactory factory) {
final List filteredList = (List) threadLocal.get();
assert filteredList.isEmpty();
try {
for (final Iterator i = children.iterator(); i.hasNext(); ) {
final String child = (String) i.next();
final File file = factory.createFile(dir, child);
if (fileFilter == null || fileFilter.accept(file))
filteredList.add(file);
}
final File[] list = new File[filteredList.size()];
filteredList.toArray(list);
return list;
} finally {
filteredList.clear(); // support garbage collection of zip controllers!
}
}
}