/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
package org.openide.loaders;
import java.util.*;
import org.openide.filesystems.FileObject;
/** This class is a lazy initialized set of FileObjects representing entries
* in MultiDataObject class. Primary file object is returned as the first from
* this set, the secondary fileobjects are sorted by getNameExt()
* method result alphabetically.
*
* This class is an implementation of performance enhancement #16396.
*
* @see Issue #16396
*
* @author Petr Hamernik
*/
final class FilesSet implements Set {
/** MDO which created this set */
private final MultiDataObject mymdo;
/** A flag */
private boolean lazyWorkDone;
/** Primary file. It is returned first. */
private FileObject primaryFile;
/** The link to secondary variable of MultiDataObject. Reading of the content
* must be synchronized on this map.
*/
private Map secondary;
/** The set containing all files. It is null and is lazy initialized
* when necessary.
*/
private TreeSet delegate;
/** Creates a new instance of FilesSet for the MultiDataObject.
* @param primaryFile The primary file - this object is returned first.
* @param secondary the map of secondary file objects. It is used
* for initialization delegate variable when necessary.
*/
public FilesSet(MultiDataObject mdo) {
this.mymdo = mdo;
}
/** Does the work which was originally done in MDO.files() method. */
private void doLazyWork() {
synchronized (this) {
if (!lazyWorkDone) {
lazyWorkDone = true;
synchronized ( mymdo.synchObjectSecondary() ) {
// cleans up invalid entries
Object res = mymdo.secondaryEntries(false);
assert res == null;
primaryFile = mymdo.getPrimaryFile();
secondary = mymdo.getSecondary();
}
}
}
}
/** Perform lazy initialization of delegate TreeSet.
*/
private Set getDelegate() {
doLazyWork();
// This synchronized block was moved from MultiDataObject.files() method,
// because of lazy initialization of delegate TreeSet.
// Hopefully won't cause threading problems.
synchronized (secondary) {
if (delegate == null) {
delegate = new TreeSet(new FilesComparator());
delegate.add(primaryFile);
delegate.addAll(secondary.keySet());
}
}
return delegate;
}
// =====================================================================
// Implementation of Set interface methods
// =====================================================================
public boolean add(FileObject obj) {
return getDelegate().add(obj);
}
public boolean addAll(Collection collection) {
return getDelegate().addAll(collection);
}
public void clear() {
getDelegate().clear();
}
public boolean contains(Object obj) {
return getDelegate().contains(obj);
}
public boolean containsAll(Collection collection) {
return getDelegate().containsAll(collection);
}
public boolean isEmpty() {
doLazyWork();
synchronized (secondary) {
return (delegate == null) ? false : delegate.isEmpty();
}
}
public Iterator iterator() {
doLazyWork();
synchronized (secondary) {
return (delegate == null) ? new FilesIterator() : delegate.iterator();
}
}
public boolean remove(Object obj) {
return getDelegate().remove(obj);
}
public boolean removeAll(Collection collection) {
return getDelegate().removeAll(collection);
}
public boolean retainAll(Collection collection) {
return getDelegate().retainAll(collection);
}
public int size() {
doLazyWork();
synchronized (secondary) {
return (delegate == null) ? (secondary.size() + 1) : delegate.size();
}
}
public Object[] toArray() {
return getDelegate().toArray();
}
public T[] toArray(T[] obj) {
return getDelegate().toArray(obj);
}
public boolean equals(Object obj) {
return getDelegate().equals(obj);
}
public String toString() {
return getDelegate().toString();
}
public int hashCode() {
return getDelegate().hashCode();
}
/** Iterator for FilesSet. It returns the primaryFile first and
* then initialize the delegate iterator for secondary files.
*/
private final class FilesIterator implements Iterator {
/** Was the first element (primary file) already returned?
*/
private boolean first = true;
/** Delegation iterator for secondary files. It is lazy initialized after
* the first element is returned.
*/
private Iterator itDelegate = null;
FilesIterator() {}
public boolean hasNext() {
return first ? true : getIteratorDelegate().hasNext();
}
public FileObject next() {
if (first) {
first = false;
return FilesSet.this.primaryFile;
}
else {
return getIteratorDelegate().next();
}
}
public void remove() {
getIteratorDelegate().remove();
}
/** Initialize the delegation iterator.
*/
private Iterator getIteratorDelegate() {
if (itDelegate == null) {
// this should return iterator of all files of the MultiDataObject...
itDelegate = FilesSet.this.getDelegate().iterator();
// ..., so it is necessary to skip the primary file
itDelegate.next();
}
return itDelegate;
}
}
/** Comparator for file objects. The primary file is less than any other file,
* so it is returned first. Other files are compared by getNameExt() method
* result.
*/
private final class FilesComparator implements Comparator {
FilesComparator() {}
public int compare(FileObject f1, FileObject f2) {
if (f1 == f2)
return 0;
if (f1 == primaryFile)
return -1;
if (f2 == primaryFile)
return 1;
int res = f1.getNameExt().compareTo(f2.getNameExt());
if (res == 0) {
// check whether they both live on the same fs
try {
if (f1.getFileSystem() == f2.getFileSystem()) {
return 0;
}
// different fs --> compare the fs names
return f1.getFileSystem().getSystemName().compareTo(
f2.getFileSystem().getSystemName());
} catch (org.openide.filesystems.FileStateInvalidException fsie) {
// should not happen - but the names were the same
// so we declare they are the same (even if the filesystems
// crashed meanwhile)
return 0;
}
}
return res;
}
}
}