ReadOnlyFilesHandler


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.modules.refactoring.spi;
21  
22  import java.util.Collection  ;
23  import org.netbeans.modules.refactoring.api.Problem;
24  import org.netbeans.modules.refactoring.api.RefactoringSession;
25  
26  /**
27   * Interface for factory classes which allows to create Problem, which ProblemDetails
28   * can handle read only files. Typically VCS can turn read only files into read write.
29   * Implementation of ReadOnlyFilesHandler is required to be registered in Lookup.
30   * More then one instance is not allowed to be registered.
31   * @author Jan Becicka
32   * @since 1.5.0
33   */
34  public interface ReadOnlyFilesHandler {
35      
36      /**
37       * Create a Problem, which ProblemDetails 
38       * can handle read only files. Typically VCS can turn read only files into
39       * read write.
40       * Typical implementation will be following:
41       * <pre>
42       * new Problem(false,
43       *    "Some files needs to be checked out for editing",
44       *     ProblemDetailsFactory.createProblemDetails(new VCSDetailsImpl(files))
45       * );
46       * </pre>
47       * @param files Collection of FileObjects
48       * @param session current refactoring session
49       * @return Problem with ProblemDetails, which can handle read only files.
50       * @see ProblemDetailsImplementation
51       */
52      public Problem createProblem(RefactoringSession session, Collection   files); 
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags