← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to versioncontrol/util/src/org/netbeans/modules/versioning/util/FileCollection.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
versioncontrol/util/src/org/netbeans/modules/versioning/util/FileCollection.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
package org.netbeans.modules.versioning.util;
 
42
 
 
43
import org.netbeans.modules.versioning.spi.VersioningSupport;
 
44
 
 
45
import java.io.File;
 
46
import java.util.*;
 
47
import java.util.prefs.Preferences;
 
48
 
 
49
/**
 
50
 * Collection of Files that has special contracts for add, remove and contains methods, see below.
 
51
 * 
 
52
 * @author Maros Sandor
 
53
 */
 
54
public class FileCollection {
 
55
    
 
56
    private static final char FLAT_FOLDER_MARKER = '*';
 
57
    
 
58
    private final Set<File> storage = new HashSet<File>(1);
 
59
    
 
60
    public synchronized void load(Preferences prefs, String key) {
 
61
        List<String> paths = Utils.getStringList(prefs, key);
 
62
        storage.clear();        
 
63
        for (String path : paths) {
 
64
            if (path.charAt(0) == FLAT_FOLDER_MARKER) {
 
65
                storage.add(VersioningSupport.getFlat(path.substring(1)));        
 
66
            } else {
 
67
                storage.add(new File(path));        
 
68
            }
 
69
        }
 
70
    }
 
71
 
 
72
    public synchronized void save(Preferences prefs, String key) {
 
73
        List<String> paths = new ArrayList<String>(storage.size());
 
74
        for (File file : storage) {
 
75
            if (VersioningSupport.isFlat(file)) {
 
76
                paths.add(FLAT_FOLDER_MARKER + file.getAbsolutePath());        
 
77
            } else {
 
78
                paths.add(file.getAbsolutePath());        
 
79
            }
 
80
        }
 
81
        Utils.put(prefs, key, paths);
 
82
    }
 
83
 
 
84
    /**
 
85
     * A file is contained in the collection either if it is in the colelction itself or there is any of its parents. 
 
86
     * 
 
87
     * @param file a file to query
 
88
     * @return true if the file is contained in the collection, false otherwise
 
89
     */
 
90
    public synchronized boolean contains(File file) {
 
91
        for (File element : storage) {
 
92
            if (Utils.isAncestorOrEqual(element, file)) return true;
 
93
        }
 
94
        return false;
 
95
    }
 
96
 
 
97
    /**
 
98
     * Adds a file to the collection. If any of its parent files is already in the collection, the file is NOT added.
 
99
     * All children of the supplied file are removed from the collection.
 
100
     * 
 
101
     * @param file a file to add
 
102
     */
 
103
    public synchronized void add(File file) {
 
104
        for (Iterator<File> i = storage.iterator(); i.hasNext(); ) {
 
105
            File element = i.next();
 
106
            if (Utils.isAncestorOrEqual(element, file)) return;
 
107
            if (Utils.isAncestorOrEqual(file, element)) {
 
108
                i.remove();
 
109
            }
 
110
        }
 
111
        storage.add(file);
 
112
    }
 
113
 
 
114
    /**
 
115
     * Removes a file from the collection. This method also removes all its parents and also all its children.
 
116
     * 
 
117
     * @param file a file to remove
 
118
     */
 
119
    public synchronized void remove(File file) {
 
120
        for (Iterator<File> i = storage.iterator(); i.hasNext(); ) {
 
121
            File element = i.next();
 
122
            if (Utils.isAncestorOrEqual(element, file) || Utils.isAncestorOrEqual(file, element)) {
 
123
                i.remove();
 
124
            }
 
125
        }
 
126
    }
 
127
}