Attachment #136614 for bug #232165

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 232165
Collapse All | Expand All




        <apidef name="JavaHintsSPI">Java Hints SPI</apidef>
    </apidefs>
    <changes>
        <change id="EnhancedJavaFix">
            <api name="JavaHintsSPI"/>
            <summary>Added ability to specify sort text for JavaFix</summary>
            <version major="1" minor="18"/>
            <date day="9" month="7" year="2013"/>
            <author login="jlahoda"/>
            <compatibility addition="yes"/>
            <description>
                <p>
                    Adding to new constructors to <code>JavaFix</code> to define
                    the sort text for the fix.
                </p>    
            </description>
        </change>
        <change id="ProjectHintsJava">
            <api name="JavaHintsSPI"/>
            <summary>Defining system filesystem folder for per-project Java hints customizers</summary>

Lines 1-7 Link Here

(-)a/spi.java.hints/nbproject/project.properties (-1 / +1 lines)
1	is.autoload=true	1	is.autoload=true
2	javac.source=1.7	2	javac.source=1.7
3	javac.compilerargs=-Xlint -Xlint:-serial	3	javac.compilerargs=-Xlint -Xlint:-serial
4	spec.version.base=1.17.0	4	spec.version.base=1.18.0
5	requires.nb.javac=true	5	requires.nb.javac=true
6	javadoc.arch=${basedir}/arch.xml	6	javadoc.arch=${basedir}/arch.xml
7	javadoc.apichanges=${basedir}/apichanges.xml	7	javadoc.apichanges=${basedir}/apichanges.xml




import org.netbeans.modules.java.source.JavaSourceAccessor;
import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;
import org.netbeans.spi.editor.hints.ChangeInfo;
import org.netbeans.spi.editor.hints.EnhancedFix;
import org.netbeans.spi.editor.hints.Fix;
import org.netbeans.spi.java.hints.HintContext;
import org.netbeans.spi.java.hints.JavaFix;

 *
 * @author Jan Lahoda
 */
public class JavaFixImpl implements Fix {

    public final JavaFix jf;


        return jf.hashCode();
    }

    public static class EnhancedJavaFixImpl extends JavaFixImpl implements EnhancedFix {

        public EnhancedJavaFixImpl(JavaFix jf) {
            super(jf);
        }

        @Override public CharSequence getSortText() {
            return Accessor.INSTANCE.getSortText(jf);
        }
        
    }
    
    public static abstract class Accessor {

        static {

        public static Accessor INSTANCE;

        public abstract String getText(JavaFix jf);
        public abstract String getSortText(JavaFix jf);
        public abstract ChangeInfo process(JavaFix jf, WorkingCopy wc, boolean canShowUI, Map<FileObject, byte[]> resourceContent, Collection<? super RefactoringElementImplementation> fileChanges) throws Exception;
        public abstract FileObject getFile(JavaFix jf);
        public abstract Map<String, String> getOptions(JavaFix jf);




import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import org.netbeans.api.annotations.common.NonNull;
import org.netbeans.api.annotations.common.NullAllowed;
import org.netbeans.api.java.source.CompilationInfo;
import org.netbeans.api.java.source.TreePathHandle;
import org.netbeans.api.java.source.WorkingCopy;
import org.netbeans.api.queries.FileEncodingQuery;
import org.netbeans.modules.java.hints.spiimpl.JavaFixImpl;
import org.netbeans.modules.java.hints.spiimpl.JavaFixImpl.EnhancedJavaFixImpl;
import org.netbeans.modules.java.hints.spiimpl.batch.BatchUtilities;
import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;
import org.netbeans.spi.editor.hints.ChangeInfo;
import org.netbeans.spi.editor.hints.EnhancedFix;
import org.netbeans.spi.editor.hints.Fix;
import org.openide.filesystems.FileObject;
import org.openide.util.Exceptions;


    private final TreePathHandle handle;
    private final Map<String, String> options;
    private final String sortText;

    /**Create JavaFix with the given base {@link TreePath}. The base {@link TreePath}
     * will be passed back to the real implementation of the fix.

    protected JavaFix(@NonNull CompilationInfo info, @NonNull TreePath tp) {
        this(info, tp, Collections.<String, String>emptyMap());
    }
    
    /**Create JavaFix with the given base {@link TreePath}. The base {@link TreePath}
     * will be passed back to the real implementation of the fix.
     *
     * @param info a {@link CompilationInfo} from which the given {@link TreePath} originates
     * @param tp a {@link TreePath} that will be passed back to the
     *           {@link #performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) } method
     * @param sortText if non-null, fix returned from {@link #toEditorFix() } will be an {@link EnhancedFix},
     *                 and the given {@code sortText} will be returned from its {@link EnhancedFix#getSortText() }.
     * @since 1.18
     */
    protected JavaFix(@NonNull CompilationInfo info, @NonNull TreePath tp, @NullAllowed String sortText) {
        this(TreePathHandle.create(tp, info), Collections.<String, String>emptyMap(), sortText);
    }

    JavaFix(CompilationInfo info, TreePath tp, Map<String, String> options) {
        this(TreePathHandle.create(tp, info), options, null);
        this.options = Collections.unmodifiableMap(new HashMap<String, String>(options));
    }
    
    /**Create JavaFix with the given base {@link TreePathHandle}. The base {@link TreePathHandle}
     * will be resolved and passed back to the real implementation of the fix.
     *

        this(handle, Collections.<String, String>emptyMap());
    }

    /**Create JavaFix with the given base {@link TreePathHandle}. The base {@link TreePathHandle}
     * will be resolved and passed back to the real implementation of the fix.
     *
     * @param handle a {@link TreePathHandle} that will be resolved and passed back to the
     *              {@link #performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) } method
     * @param sortText if non-null, fix returned from {@link #toEditorFix() } will be an {@link EnhancedFix},
     *                 and the given {@code sortText} will be returned from its {@link EnhancedFix#getSortText() }.
     * @since 1.18
     */
    protected JavaFix(@NonNull TreePathHandle handle, @NullAllowed String sortText) {
        this(handle, Collections.<String, String>emptyMap());
    }

    JavaFix(TreePathHandle handle, Map<String, String> options) {
        this(handle, options, null);
    }
    
    JavaFix(TreePathHandle handle, Map<String, String> options, String sortText) {
        this.handle = handle;
        this.options = Collections.unmodifiableMap(new HashMap<String, String>(options));
        this.sortText = sortText;
    }

    /**The display text of the fix.

     * method on this {@link JavaFix}.
     */
    public final Fix toEditorFix() {
        return sortText != null ? new EnhancedJavaFixImpl(this) : new JavaFixImpl(this);
    }

    static {

            public List<Fix> resolveDefaultFixes(HintContext ctx, Fix... provided) {
                return ErrorDescriptionFactory.resolveDefaultFixes(ctx, provided);
            }

            @Override
            public String getSortText(JavaFix jf) {
                return jf.sortText;
            }
        };
    }


Return to bug 232165

Lines 63-68 Link Here

(-)a/spi.java.hints/src/org/netbeans/modules/java/hints/spiimpl/JavaFixImpl.java (-1 / +15 lines)
63	import org.netbeans.modules.java.source.JavaSourceAccessor;	63	import org.netbeans.modules.java.source.JavaSourceAccessor;
64	import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;	64	import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;
65	import org.netbeans.spi.editor.hints.ChangeInfo;	65	import org.netbeans.spi.editor.hints.ChangeInfo;
		66	import org.netbeans.spi.editor.hints.EnhancedFix;
66	import org.netbeans.spi.editor.hints.Fix;	67	import org.netbeans.spi.editor.hints.Fix;
67	import org.netbeans.spi.java.hints.HintContext;	68	import org.netbeans.spi.java.hints.HintContext;
68	import org.netbeans.spi.java.hints.JavaFix;	69	import org.netbeans.spi.java.hints.JavaFix;
Lines 73-79 Link Here
73	*	74	*
74	* @author Jan Lahoda	75	* @author Jan Lahoda
75	*/	76	*/
76	public final class JavaFixImpl implements Fix {	77	public class JavaFixImpl implements Fix {
77		78
78	public final JavaFix jf;	79	public final JavaFix jf;
79		80
Lines 122-127 Link Here
122	return jf.hashCode();	123	return jf.hashCode();
123	}	124	}
124		125
		126	public static class EnhancedJavaFixImpl extends JavaFixImpl implements EnhancedFix {
		127
		128	public EnhancedJavaFixImpl(JavaFix jf) {
		129	super(jf);
		130	}
		131
		132	@Override public CharSequence getSortText() {
		133	return Accessor.INSTANCE.getSortText(jf);
		134	}
		135
		136	}
		137
125	public static abstract class Accessor {	138	public static abstract class Accessor {
126		139
127	static {	140	static {
Lines 135-140 Link Here
135	public static Accessor INSTANCE;	148	public static Accessor INSTANCE;
136		149
137	public abstract String getText(JavaFix jf);	150	public abstract String getText(JavaFix jf);
		151	public abstract String getSortText(JavaFix jf);
138	public abstract ChangeInfo process(JavaFix jf, WorkingCopy wc, boolean canShowUI, Map<FileObject, byte[]> resourceContent, Collection<? super RefactoringElementImplementation> fileChanges) throws Exception;	152	public abstract ChangeInfo process(JavaFix jf, WorkingCopy wc, boolean canShowUI, Map<FileObject, byte[]> resourceContent, Collection<? super RefactoringElementImplementation> fileChanges) throws Exception;
139	public abstract FileObject getFile(JavaFix jf);	153	public abstract FileObject getFile(JavaFix jf);
140	public abstract Map<String, String> getOptions(JavaFix jf);	154	public abstract Map<String, String> getOptions(JavaFix jf);

Lines 60-73 Link Here

(-)a/spi.java.hints/src/org/netbeans/spi/java/hints/JavaFix.java (-4 / +44 lines)
60	import javax.swing.text.BadLocationException;	60	import javax.swing.text.BadLocationException;
61	import javax.swing.text.Document;	61	import javax.swing.text.Document;
62	import org.netbeans.api.annotations.common.NonNull;	62	import org.netbeans.api.annotations.common.NonNull;
		63	import org.netbeans.api.annotations.common.NullAllowed;
63	import org.netbeans.api.java.source.CompilationInfo;	64	import org.netbeans.api.java.source.CompilationInfo;
64	import org.netbeans.api.java.source.TreePathHandle;	65	import org.netbeans.api.java.source.TreePathHandle;
65	import org.netbeans.api.java.source.WorkingCopy;	66	import org.netbeans.api.java.source.WorkingCopy;
66	import org.netbeans.api.queries.FileEncodingQuery;	67	import org.netbeans.api.queries.FileEncodingQuery;
67	import org.netbeans.modules.java.hints.spiimpl.JavaFixImpl;	68	import org.netbeans.modules.java.hints.spiimpl.JavaFixImpl;
		69	import org.netbeans.modules.java.hints.spiimpl.JavaFixImpl.EnhancedJavaFixImpl;
68	import org.netbeans.modules.java.hints.spiimpl.batch.BatchUtilities;	70	import org.netbeans.modules.java.hints.spiimpl.batch.BatchUtilities;
69	import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;	71	import org.netbeans.modules.refactoring.spi.RefactoringElementImplementation;
70	import org.netbeans.spi.editor.hints.ChangeInfo;	72	import org.netbeans.spi.editor.hints.ChangeInfo;
		73	import org.netbeans.spi.editor.hints.EnhancedFix;
71	import org.netbeans.spi.editor.hints.Fix;	74	import org.netbeans.spi.editor.hints.Fix;
72	import org.openide.filesystems.FileObject;	75	import org.openide.filesystems.FileObject;
73	import org.openide.util.Exceptions;	76	import org.openide.util.Exceptions;
Lines 85-90 Link Here
85		88
86	private final TreePathHandle handle;	89	private final TreePathHandle handle;
87	private final Map<String, String> options;	90	private final Map<String, String> options;
		91	private final String sortText;
88		92
89	/**Create JavaFix with the given base {@link TreePath}. The base {@link TreePath}	93	/**Create JavaFix with the given base {@link TreePath}. The base {@link TreePath}
90	* will be passed back to the real implementation of the fix.	94	* will be passed back to the real implementation of the fix.
Lines 96-107 Link Here
96	protected JavaFix(@NonNull CompilationInfo info, @NonNull TreePath tp) {	100	protected JavaFix(@NonNull CompilationInfo info, @NonNull TreePath tp) {
97	this(info, tp, Collections.<String, String>emptyMap());	101	this(info, tp, Collections.<String, String>emptyMap());
98	}	102	}
		103
		104	/**Create JavaFix with the given base {@link TreePath}. The base {@link TreePath}
		105	* will be passed back to the real implementation of the fix.
		106	*
		107	* @param info a {@link CompilationInfo} from which the given {@link TreePath} originates
		108	* @param tp a {@link TreePath} that will be passed back to the
		109	* {@link #performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) } method
		110	* @param sortText if non-null, fix returned from {@link #toEditorFix() } will be an {@link EnhancedFix},
		111	* and the given {@code sortText} will be returned from its {@link EnhancedFix#getSortText() }.
		112	* @since 1.18
		113	*/
		114	protected JavaFix(@NonNull CompilationInfo info, @NonNull TreePath tp, @NullAllowed String sortText) {
		115	this(TreePathHandle.create(tp, info), Collections.<String, String>emptyMap(), sortText);
		116	}
99		117
100	JavaFix(CompilationInfo info, TreePath tp, Map<String, String> options) {	118	JavaFix(CompilationInfo info, TreePath tp, Map<String, String> options) {
101	this.handle = TreePathHandle.create(tp, info);	119	this(TreePathHandle.create(tp, info), options, null);
102	this.options = Collections.unmodifiableMap(new HashMap<String, String>(options));
103	}	120	}
104		121
105	/**Create JavaFix with the given base {@link TreePathHandle}. The base {@link TreePathHandle}	122	/**Create JavaFix with the given base {@link TreePathHandle}. The base {@link TreePathHandle}
106	* will be resolved and passed back to the real implementation of the fix.	123	* will be resolved and passed back to the real implementation of the fix.
107	*	124	*
Lines 112-120 Link Here
112	this(handle, Collections.<String, String>emptyMap());	129	this(handle, Collections.<String, String>emptyMap());
113	}	130	}
114		131
		132	/**Create JavaFix with the given base {@link TreePathHandle}. The base {@link TreePathHandle}
		133	* will be resolved and passed back to the real implementation of the fix.
		134	*
		135	* @param handle a {@link TreePathHandle} that will be resolved and passed back to the
		136	* {@link #performRewrite(org.netbeans.spi.java.hints.JavaFix.TransformationContext) } method
		137	* @param sortText if non-null, fix returned from {@link #toEditorFix() } will be an {@link EnhancedFix},
		138	* and the given {@code sortText} will be returned from its {@link EnhancedFix#getSortText() }.
		139	* @since 1.18
		140	*/
		141	protected JavaFix(@NonNull TreePathHandle handle, @NullAllowed String sortText) {
		142	this(handle, Collections.<String, String>emptyMap());
		143	}
		144
115	JavaFix(TreePathHandle handle, Map<String, String> options) {	145	JavaFix(TreePathHandle handle, Map<String, String> options) {
		146	this(handle, options, null);
		147	}
		148
		149	JavaFix(TreePathHandle handle, Map<String, String> options, String sortText) {
116	this.handle = handle;	150	this.handle = handle;
117	this.options = Collections.unmodifiableMap(new HashMap<String, String>(options));	151	this.options = Collections.unmodifiableMap(new HashMap<String, String>(options));
		152	this.sortText = sortText;
118	}	153	}
119		154
120	/**The display text of the fix.	155	/**The display text of the fix.
Lines 137-143 Link Here
137	* method on this {@link JavaFix}.	172	* method on this {@link JavaFix}.
138	*/	173	*/
139	public final Fix toEditorFix() {	174	public final Fix toEditorFix() {
140	return new JavaFixImpl(this);	175	return sortText != null ? new EnhancedJavaFixImpl(this) : new JavaFixImpl(this);
141	}	176	}
142		177
143	static {	178	static {
Lines 187-192 Link Here
187	public List<Fix> resolveDefaultFixes(HintContext ctx, Fix... provided) {	222	public List<Fix> resolveDefaultFixes(HintContext ctx, Fix... provided) {
188	return ErrorDescriptionFactory.resolveDefaultFixes(ctx, provided);	223	return ErrorDescriptionFactory.resolveDefaultFixes(ctx, provided);
189	}	224	}
		225
		226	@Override
		227	public String getSortText(JavaFix jf) {
		228	return jf.sortText;
		229	}
190	};	230	};
191	}	231	}
192		232

Lines 46-51 Link Here

(-)a/spi.java.hints/apichanges.xml (+14 lines)
46	<apidef name="JavaHintsSPI">Java Hints SPI</apidef>	46	<apidef name="JavaHintsSPI">Java Hints SPI</apidef>
47	</apidefs>	47	</apidefs>
48	<changes>	48	<changes>
		49	<change id="EnhancedJavaFix">
		50	<api name="JavaHintsSPI"/>
		51	<summary>Added ability to specify sort text for JavaFix</summary>
		52	<version major="1" minor="18"/>
		53	<date day="9" month="7" year="2013"/>
		54	<author login="jlahoda"/>
		55	<compatibility addition="yes"/>
		56	<description>
		57	<p>
		58	Adding to new constructors to <code>JavaFix</code> to define
		59	the sort text for the fix.
		60	</p>
		61	</description>
		62	</change>
49	<change id="ProjectHintsJava">	63	<change id="ProjectHintsJava">
50	<api name="JavaHintsSPI"/>	64	<api name="JavaHintsSPI"/>
51	<summary>Defining system filesystem folder for per-project Java hints customizers</summary>	65	<summary>Defining system filesystem folder for per-project Java hints customizers</summary>