org.netbeans.spi.java.queries

Interface BinaryForSourceQueryImplementation2<Result>

Type Parameters:

Result - any type this implementation wants to use as a result

All Superinterfaces:

BinaryForSourceQueryImplementation

public interface BinaryForSourceQueryImplementation2<Result>
extends BinaryForSourceQueryImplementation

Extended query about the binaries. In addition to BinaryForSourceQueryImplementation, this query also allows one to specify whether binaries are preferred - e.g. copied instead of obtaining them by compiling the sources. The typical implementation of the query looks like:

@ServiceProvider(service = BinaryForSourceQueryImplementation.class)
public final static class SampleQuery
implements BinaryForSourceQueryImplementation2<SampleQuery.PrivateData> {
    public SampleQuery() {
    }

    @Override
    public PrivateData findBinaryRoots2(URL sourceRoot) {
        final FileObject fo = URLMapper.findFileObject(sourceRoot);
        assertNotNull("FileObject found", fo);
        return new PrivateData(sourceRoot, fo);
    }

    @Override
    public URL[] computeRoots(PrivateData result) {
        return new URL[] { result.url };
    }

    @Override
    public boolean computePreferBinaries(PrivateData result) {
        return true;
    }

    @Override
    public void computeChangeListener(PrivateData data, boolean add, ChangeListener l) {
        if (add) {
            assertNull("No listener yet", data.listener);
            data.listener = l;
        } else {
            assertEquals("Removing", data.listener, l);
            data.listener = null;
        }
    }

    public static final class PrivateData {
        final URL url;
        final FileObject fo;
        ChangeListener listener;

        PrivateData(URL url, FileObject fo) {
            this.fo = fo;
            this.url = url;
        }

        @Override
        public int hashCode() {
            int hash = 7;
            hash = 97 * hash + Objects.hashCode(this.url);
            return hash;
        }

        @Override
        public boolean equals(Object obj) {
            if (this == obj) {
                return true;
            }
            if (obj == null) {
                return false;
            }
            if (getClass() != obj.getClass()) {
                return false;
            }
            final PrivateData other = (PrivateData) obj;
            return Objects.equals(this.url, other.url);
        }
    }
}

Since:

1.58

See Also:

BinaryForSourceQuery, SourceForBinaryQuery, BinaryForSourceQueryImplementation, SourceForBinaryQueryImplementation

Method Summary

Modifier and Type	Method and Description
void	computeChangeListener(Result result, boolean add, ChangeListener l) Implementation of add and remove listener.
boolean	computePreferBinaries(Result result) Implementation of BinaryForSourceQuery.Result2.preferBinaries().
URL[]	computeRoots(Result result) Implementation of BinaryForSourceQuery.Result.getRoots().
default BinaryForSourceQuery.Result2	findBinaryRoots(URL sourceRoot) Default implementation of BinaryForSourceQueryImplementation.findBinaryRoots(java.net.URL).
Result	findBinaryRoots2(URL sourceRoot) Returns the binary root result for a given source root.

Method Detail

findBinaryRoots

default BinaryForSourceQuery.Result2 findBinaryRoots(URL sourceRoot)

Default implementation of BinaryForSourceQueryImplementation.findBinaryRoots(java.net.URL). Calls BinaryForSourceQueryImplementation2.findBinaryRoots2(java.net.URL) and if the method returns non-null value, then it creates instances of BinaryForSourceQuery.Result2 and returns it. Otherwise it returns null.

Override BinaryForSourceQueryImplementation2.findBinaryRoots2(java.net.URL), not this method!

Specified by:

findBinaryRoots in interface BinaryForSourceQueryImplementation

Parameters:

sourceRoot -

Returns:

non-null result if this query has an answer for the provided sourceRoot

Since:

1.58

findBinaryRoots2

Result findBinaryRoots2(URL sourceRoot)

Returns the binary root result for a given source root.

The returned Result must be consistent. It means that for repeated calling of this method with the same recognized root the method has to return the equal result with the same Object.hashCode(). The implementation of the BinaryForSourceQueryImplementation2.findBinaryRoots(java.net.URL) method makes sure the same BinaryForSourceQuery.Result2 instance is returned for two equal Result objects.

Parameters:

sourceRoot - the source path root

Returns:

null if the sourceRoot is not recognized, or any object to feed into BinaryForSourceQueryImplementation2.computeRoots(java.lang.Object) & co. methods any time later

Since:

1.58

computeRoots

URL[] computeRoots(Result result)

Implementation of BinaryForSourceQuery.Result.getRoots().

Parameters:

result - object created by BinaryForSourceQueryImplementation2.findBinaryRoots2(java.net.URL) method

Returns:

result to return from BinaryForSourceQuery.Result.getRoots()

Since:

1.58

computePreferBinaries

boolean computePreferBinaries(Result result)

Implementation of BinaryForSourceQuery.Result2.preferBinaries().

Parameters:

result - object created by BinaryForSourceQueryImplementation2.findBinaryRoots2(java.net.URL) method

Returns:

result to return from BinaryForSourceQuery.Result2.preferBinaries()

Since:

1.58

computeChangeListener

void computeChangeListener(Result result,
                           boolean add,
                           ChangeListener l)

Implementation of add and remove listener.

Parameters:

result - object created by BinaryForSourceQueryImplementation2.findBinaryRoots2(java.net.URL) method

l - the listener to operate on

add - add or remove the listener?

Since:

1.58