TextFileBuilder (PMD Core 7.7.0 API)

java.lang.Object
- net.sourceforge.pmd.lang.document.TextFileBuilder

```
public abstract class TextFileBuilder
extends Object
```
A builder for a new text file. See static methods on TextFile.

Field Summary

Fields
Modifier and Type Field Description

protected LanguageVersion languageVersion

protected FileId parentFsId

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`TextFileBuilder`	`asReadOnly()`	Specify that the built file is read only.
`abstract TextFile`	`build()`	Creates and returns the new text file.
`TextFileBuilder`	`setParentFsPath(@Nullable FileId fileId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

languageVersion

protected final LanguageVersion languageVersion

parentFsId
```
protected FileId parentFsId
```

Method Detail
- asReadOnly
```
public TextFileBuilder asReadOnly()
```
  Specify that the built file is read only. Some text files are always read-only.
  
  Returns:
  
  This builder
- setParentFsPath
```
public TextFileBuilder setParentFsPath(@Nullable FileId fileId)
```
- build
```
public abstract TextFile build()
```
  Creates and returns the new text file.