Class AbstractSource

exist-core/src/main/java/org/exist/source/AbstractSource.java:47–160

@author wolf @author Adam Retter

 * @author <a href="mailto:adam@evolvedbinary.com">Adam Retter</a>
 */
public abstract class AbstractSource implements Source {

    private final long key;

    protected AbstractSource(final long key) {
        this.key = key;
    }

    @Override
    public long getKey() {
        return key;
    }

    @Override
    public Charset getEncoding() throws IOException {
        return null;
    }

    @Deprecated
    public void validate(final Subject subject, final int perm) throws PermissionDeniedException {
        // no-op
    }

    @Override
    public boolean equals(final Object obj) {
    	if (obj != null && obj instanceof Source) {
            return key == (((Source)obj).getKey());
		}
    	return false;
    }

    public abstract int hashCode();

    @Override
    public QName isModule() throws IOException {
        return null;
    }

    /**
     * Check if the XQuery file declares a content encoding in the
     * XQuery declaration.
     *
     * @param is the input stream
     * @return The guessed encoding.
     */
    protected static String guessXQueryEncoding(final InputStream is) {
        final XQueryLexer lexer = new XQueryLexer(null, new InputStreamReader(is));
        final DeclScanner scanner = new DeclScanner(lexer);
        try {
            scanner.versionDecl();
        } catch (final RecognitionException | XPathException | TokenStreamException e) {
            //Nothing to do
        }
        return scanner.getEncoding();
    }

    /**
     * Check if the source is an XQuery module. If yes, return a QName containing