ReadOnlyFilesHandler (Refactoring API) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.refactoring.api 1.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.modules.refactoring.spi
Interface ReadOnlyFilesHandler

public interface ReadOnlyFilesHandler

Interface for factory classes which allows to create Problem, which ProblemDetails can handle read only files. Typically VCS can turn read only files into read write. Implementation of ReadOnlyFilesHandler is required to be registered in Lookup. More then one instance is not allowed to be registered.

Since:: 1.5.0

Method Summary

Problem createProblem(RefactoringSession session, Collection files)
Create a Problem, which ProblemDetails can handle read only files.

Method Summary
`Problem`	`createProblem(RefactoringSession session, Collection files)` Create a Problem, which ProblemDetails can handle read only files.

Method Detail

createProblem

Problem createProblem(RefactoringSession session,
                      Collection files)

Create a Problem, which ProblemDetails can handle read only files. Typically VCS can turn read only files into read write. Typical implementation will be following:

 new Problem(false,
    "Some files needs to be checked out for editing",
     ProblemDetailsFactory.createProblemDetails(new VCSDetailsImpl(files))
 );

Parameters:: files - Collection of FileObjects; session - current refactoring session
Returns:: Problem with ProblemDetails, which can handle read only files.
See Also:: ProblemDetailsImplementation