Package org.openrewrite.text

Class PlainTextParser

java.lang.Object

org.openrewrite.text.PlainTextParser

All Implemented Interfaces:

Parser<PlainText>

public class PlainTextParser
extends Object
implements Parser<PlainText>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlainTextParser.Builder

Nested classes/interfaces inherited from interface org.openrewrite.Parser

Parser.Input

Constructor Summary

Constructors

Constructor	Description
PlainTextParser()

Method Summary

Modifier and Type	Method	Description
boolean	accept(Path path)
static PlainTextParser.Builder	builder()
static PlainText	convert(SourceFile sourceFile)	Downcast a SourceFile to a PlainText if it isn't already one.
List<PlainText>	parseInputs(Iterable<Parser.Input> sources, @Nullable Path relativeTo, ExecutionContext ctx)
Path	sourcePathFromSourceText(Path prefix, String sourceCode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openrewrite.Parser

accept, acceptedInputs, getCharset, parse, parse, parse, reset

Constructor Details

PlainTextParser

public PlainTextParser()

Method Details

convert

public static PlainText convert(SourceFile sourceFile)

Downcast a SourceFile to a PlainText if it isn't already one.

Parameters:

sourceFile - A source file which may be a PlainText or not.

Returns:

The same PlainText reference if the source file is already a PlainText. Otherwise, a new PlainText instance with the same contents as the source file.

parseInputs

public List<PlainText> parseInputs(Iterable<Parser.Input> sources,
 @Nullable
 @Nullable Path relativeTo,
 ExecutionContext ctx)

Specified by:

parseInputs in interface Parser<PlainText>

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 list of SourceFile.

accept

public boolean accept(Path path)

Specified by:

accept in interface Parser<PlainText>

sourcePathFromSourceText

public Path sourcePathFromSourceText(Path prefix,
 String sourceCode)

Specified by:

sourcePathFromSourceText in interface Parser<PlainText>

builder

public static PlainTextParser.Builder builder()