Package org.openrewrite

Interface Parser

All Known Implementing Classes:

BinaryParser, PlainTextParser, QuarkParser

public interface Parser

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Parser.Builder
static class	Parser.Input	A source input.

Method Summary

Modifier and Type	Method	Description
boolean	accept(Path path)
default boolean	accept(Parser.Input input)
default Stream<Parser.Input>	acceptedInputs(Iterable<Parser.Input> input)
default Charset	getCharset(ExecutionContext ctx)	Returns the ExecutionContext charset if its defined otherwise returns StandardCharsets.UTF_8
default Stream<SourceFile>	parse(Iterable<Path> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx)
default Stream<SourceFile>	parse(String... sources)
default Stream<SourceFile>	parse(ExecutionContext ctx, String... sources)
Stream<SourceFile>	parseInputs(Iterable<Parser.Input> sources, @Nullable Path relativeTo, ExecutionContext ctx)
default SourceFile	requirePrintEqualsInput(SourceFile sourceFile, Parser.Input input, @Nullable Path relativeTo, ExecutionContext ctx)
default Parser	reset()
Path	sourcePathFromSourceText(Path prefix, String sourceCode)

Method Details

requirePrintEqualsInput

@Incubating(since="8.2.0")
default SourceFile requirePrintEqualsInput(SourceFile sourceFile,
 Parser.Input input,
 @Nullable
 @Nullable Path relativeTo,
 ExecutionContext ctx)

parse

default Stream<SourceFile> parse(Iterable<Path> sourceFiles,
 @Nullable
 @Nullable Path relativeTo,
 ExecutionContext ctx)

parse

default Stream<SourceFile> parse(String... sources)

parse

default Stream<SourceFile> parse(ExecutionContext ctx,
 String... sources)

parseInputs

Stream<SourceFile> parseInputs(Iterable<Parser.Input> sources,
 @Nullable
 @Nullable Path relativeTo,
 ExecutionContext ctx)

Parameters:

sources - A collection of inputs. At the conclusion of parsing all sources' Parser.Input.source are closed.

relativeTo - A common relative path for all Parser.Input.path.

ctx - The execution context

Returns:

A stream of SourceFile.

accept

boolean accept(Path path)

accept

default boolean accept(Parser.Input input)

acceptedInputs

default Stream<Parser.Input> acceptedInputs(Iterable<Parser.Input> input)

reset

default Parser reset()

getCharset

default Charset getCharset(ExecutionContext ctx)

Returns the ExecutionContext charset if its defined otherwise returns StandardCharsets.UTF_8

sourcePathFromSourceText

Path sourcePathFromSourceText(Path prefix,
 String sourceCode)