@StaticResource private static final String ICON_FIND = "org/openide/awt/resources/quicksearch/find.png"; // NOI18N @StaticResource private static final String ICON_FIND_WITH_MENU = "org/openide/awt/resources/quicksearch/findMenu.png"; // NOI18N private static final Object CLIENT_PROPERTY_KEY = new Object();
private Result( @NonNull final Status status, @NullAllowed final String message) { this.status = status; this.message = message; }
/** * Creates a document for the given mime type. * @param mimeType the MIME type * @return document instance or {@code null} */ @CheckForNull public Document createDocument(@NonNull String mimeType);
/** * Get the test directory of this PHP module for the given file. * @param file file to get test directory for, can be {@code null} (in such case, * simply the first test directory is returned) * @return the test directory, can be {@code null} if no test directory set yet * @see #getTestDirectories() */ @CheckForNull FileObject getTestDirectory(@NullAllowed FileObject file);
ClasspathInfoListener ( @NonNull final ChangeSupport changedSupport, @NullAllowed final Runnable callBack) { assert changedSupport != null; this.changeSupport = changedSupport; this.callBack = callBack; }
/** * Returns a {@link Document} for the given {@link FileObject}. * @param file the {@link FileObject} to create {@link Document} for * @return the document instance or {@code null} */ @CheckForNull public Document getDocument(@NonNull FileObject file);
protected PrefetchableBase( @NonNull final String pkgName, @NonNull final String name, @NullAllowed final Charset encoding, final boolean caseSensitive) { super(pkgName, name, encoding, caseSensitive); }
/** * Create project customizer for the given PHP module. * @param phpModule the PHP module; never {@code null} * @return project customizer, can be {@code null} if not supported * @since 0.8 */ @CheckForNull ProjectCustomizer.CompositeCategoryProvider createCustomizer(@NonNull PhpModule phpModule);
CachedZipFileObject( @NonNull final ZipFile zipFile, @NullAllowed final String pathToRootInArchive, @NonNull final String folderName, @NonNull final String baseName, final long mtime) { super (pathToRootInArchive, folderName, baseName, mtime); assert zipFile != null : "archiveFile == null"; //NOI18N this.zipFile = zipFile; }
/** * Checks if given folder can be converted into a {@link Project}. * Called only for folders accepted by the {@link ProjectConvertor.Registration#requiredPattern}. * @param projectDirectory the folder to check * @return the {@link ProjectConvertor.Result} if the folder can be * converted to a {@link Project} or null. */ @CheckForNull Result isProject(@NonNull FileObject projectDirectory);
CTSymArchive( @NonNull final File archive, @NullAllowed final String pathToRootInArchive, @NonNull final File ctSym, @NullAllowed final String pathToRootInCtSym) { super(archive, pathToRootInArchive, true); this.ctSym = ctSym; this.pathToRootInCtSym = pathToRootInCtSym; }
/** * Returns a {@link FileObject} for given {@link Document}. * @param document the {@link Document} to find {@link FileObject} for * @return the {@link FileObject} or {@code null} */ @CheckForNull public FileObject getFileObject(@NonNull Document document);
@NonNull public static Accessibility fromQuery(@NullAllowed final Boolean accessibilityQueryResult) { if (accessibilityQueryResult == null) { return UNKNOWN; } else if (accessibilityQueryResult) { return EXPORTED; } else { return PRIVATE; } } }
/** * Returns the value of the variable or <code>null</code>. * * @param name the name of the variable * @return the value of the variable or <code>null</code> */ @CheckForNull String getVariable(@NonNull String name);
/** * Creates new annotation parsed line. * * @param name name of the annotation; never {@code null} * @param types types of the annotation; can be {@code null} * @param description description of the annotation; can be {@code null} */ public ParsedLine(@NonNull final String name, @NullAllowed final Map<OffsetRange, String> types, @NullAllowed final String description) { this(name, types, description, false); }
/** * Get current position. * * @param io The I/O instance. * @param writer Output or error writer. If the streams are merged, the * value can be ignored. * * @return The current position in the output pane. If this feature is not * supported, return null. */ @CheckForNull POS getCurrentPosition(@NonNull IO io, @NonNull WRITER writer);
/** * Called to extend the given web module and JSF framework with the JSF * component library corresponding to this implementation. * * @param webModule the web module to be extended; never null. * @param jsfComponentCustomizer customizer with JSF component library * settings for given project (web module) * @return the set of newly created files in the web module which should be opened. */ @NonNull Set<FileObject> extend(@NonNull WebModule webModule, @NullAllowed JsfComponentCustomizer jsfComponentCustomizer);
/** * Creates new annotation parsed line. * * @param name name of the annotation; never {@code null} * @param types types of the annotation; can be {@code null} */ public ParsedLine(@NonNull final String name, @NullAllowed final Map<OffsetRange, String> types) { this(name, types, null, false); }
/** * Creates new annotation parsed line. * * @param name name of the annotation; never {@code null} * @param description description of the annotation; can be {@code null} */ public ParsedLine(@NonNull final String name, @NullAllowed final String description) { this(name, null, description, false); }
/** * Add new test suite to this test session. * @param name name of the test suite * @param location location of the test suite, can be {@code null} * @return new test suite * @see TestSuite#finish(long) * @since 0.2 */ TestSuite addTestSuite(@NonNull String name, @NullAllowed FileObject location);