KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > refactoring > api > ProblemDetails


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.api;
21
22 import javax.swing.Action JavaDoc;
23 import org.netbeans.modules.refactoring.spi.ProblemDetailsImplementation;
24 import org.openide.util.Cancellable;
25
26 /**
27  * This class holds details of a Problem
28  * @author Jan Becicka
29  * @since 1.5.0
30  */
31 public final class ProblemDetails {
32
33     private ProblemDetailsImplementation pdi;
34
35     ProblemDetails (ProblemDetailsImplementation pdi) {
36         this.pdi=pdi;
37     }
38
39     /**
40      * This method will typically invoke component with ProblemDetails.
41      * It is fully upon clients, how this component will be implemented.
42      * @param rerunRefactoringAction this action is passed to client component
43      * to allow clients to invoke refactoring once the Problem is fixed.
44      * @param parent component, which can be cancelled
45      * @see ProblemDetailsImplementation
46      */
47     public void showDetails(Action JavaDoc rerunRefactoringAction, Cancellable parent) {
48         pdi.showDetails(rerunRefactoringAction, parent);
49     }
50     
51     /**
52      * Message that will be displayed in parameters panel as a hint to suggest user,
53      * that there are more details available.
54      * @return string representation of hint
55      */
56     public String JavaDoc getDetailsHint() {
57         return pdi.getDetailsHint();
58     }
59 }
60
Popular Tags