DefaultInputFile (SonarQube :: Plugin API 6.6 API)

java.lang.Object
- org.sonar.api.batch.fs.internal.DefaultInputComponent
- - org.sonar.api.batch.fs.internal.DefaultInputFile

All Implemented Interfaces:

IndexedFile, InputComponent, InputFile, InputPath
```
public class DefaultInputFile
extends DefaultInputComponent
implements InputFile
```
Since:

4.2 To create InputFile in tests, use TestInputFileBuilder.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.sonar.api.batch.fs.InputFile
  InputFile.Status, InputFile.Type

Constructor Summary

Constructors
Constructor and Description
`DefaultInputFile(DefaultIndexedFile indexedFile, Consumer<DefaultInputFile> metadataGenerator)`
`DefaultInputFile(DefaultIndexedFile indexedFile, Consumer<DefaultInputFile> metadataGenerator, String contents)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`absolutePath()` Normalized absolute path.
`Charset`	`charset()` Charset to be used to decode this specific file.
`void`	`checkMetadata()`
`String`	`contents()` Fetches the entire contents of the file, decoding with the `InputFile.charset()`.
`boolean`	`equals(Object obj)`
`File`	`file()` The underlying absolute `File`.
`String`	`filename()` Filename for this file (inclusing extension).
`String`	`getModuleRelativePath()`
`String`	`getProjectRelativePath()`
`String`	`hash()` Digest hash of the file.
`int`	`hashCode()`
`InputStream`	`inputStream()` Creates a stream of the file's contents.
`boolean`	`isEmpty()` Check if the file content is empty (ignore potential BOM).
`boolean`	`isExcludedForCoverage()`
`boolean`	`isFile()` Is the component an `InputFile`
`boolean`	`isPublished()`
`String`	`key()` Component key (without branch).
`String`	`language()` Language, for example "java" or "php".
`int`	`lastValidOffset()`
`int`	`lines()` Number of physical lines.
`String`	`moduleKey()`
`TextPointer`	`newPointer(int globalOffset)`
`TextPointer`	`newPointer(int line, int lineOffset)` Returns a `TextPointer` in the given file.
`TextRange`	`newRange(int startOffset, int endOffset)` Create Range from global offsets.
`TextRange`	`newRange(int startLine, int startLineOffset, int endLine, int endLineOffset)` Returns a `TextRange` in the given file.
`TextRange`	`newRange(TextPointer start, TextPointer end)` Returns a `TextRange` in the given file.
`int`	`nonBlankLines()`
`int[]`	`originalLineOffsets()`
`Path`	`path()` The underlying absolute `Path`.
`String`	`relativePath()` Deprecated. since 6.6
`TextRange`	`selectLine(int line)` Returns a `TextRange` in the given file that select the full line.
`DefaultInputFile`	`setCharset(Charset charset)`
`DefaultInputFile`	`setExcludedForCoverage(boolean excludedForCoverage)`
`DefaultInputFile`	`setMetadata(Metadata metadata)`
`DefaultInputFile`	`setPublished(boolean published)`
`DefaultInputFile`	`setStatus(InputFile.Status status)`
`InputFile.Status`	`status()` `setStatus(org.sonar.api.batch.fs.InputFile.Status)`
`String`	`toString()` Return a string to identify this file (suitable for logs).
`InputFile.Type`	`type()` Does it contain main or test code ?
`URI`	`uri()` Identifier of the file.
`void`	`validate(TextRange range)`

Methods inherited from class org.sonar.api.batch.fs.internal.DefaultInputComponent
batchId

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

- Constructor Detail
  - DefaultInputFile
```
public DefaultInputFile(DefaultIndexedFile indexedFile,
                        Consumer<DefaultInputFile> metadataGenerator)
```
  - DefaultInputFile
```
public DefaultInputFile(DefaultIndexedFile indexedFile,
                        Consumer<DefaultInputFile> metadataGenerator,
                        @Nullable
                        String contents)
```
- Method Detail
  - checkMetadata
```
public void checkMetadata()
```
  - inputStream
```
public InputStream inputStream()
                        throws IOException
```
    Description copied from interface: InputFile
    
    Creates a stream of the file's contents. Depending on the runtime context, the source might be a file in a physical or virtual filesystem. Typically, it won't be buffered. The stream must be closed by the caller. Since 6.4 BOM is automatically filtered out.
    
    Specified by:
    
    inputStream in interface IndexedFile
    
    Specified by:
    
    inputStream in interface InputFile
    
    Throws:
    
    IOException
  - contents
```
public String contents()
                throws IOException
```
    Description copied from interface: InputFile
    
    Fetches the entire contents of the file, decoding with the InputFile.charset(). Since 6.4 BOM is automatically filtered out.
    
    Specified by:
    
    contents in interface InputFile
    
    Throws:
    
    IOException
  - setPublished
```
public DefaultInputFile setPublished(boolean published)
```
  - isPublished
```
public boolean isPublished()
```
  - setExcludedForCoverage
```
public DefaultInputFile setExcludedForCoverage(boolean excludedForCoverage)
```
  - isExcludedForCoverage
```
public boolean isExcludedForCoverage()
```
  - relativePath
```
@Deprecated
public String relativePath()
```
    Deprecated. since 6.6
    
    Description copied from interface: InputFile
    
    Relative path to module (for normal Sensors) or project (for global Sensors) base directory. File separator is the forward slash ('/'), even on Microsoft Windows.
    Returns src/main/java/com/Foo.java if module base dir is /path/to/module and if file is /path/to/module/src/main/java/com/Foo.java.
    Relative path is not null and is normalized ('foo/../foo' is replaced by 'foo').
    
    Specified by:
    
    relativePath in interface IndexedFile
    
    Specified by:
    
    relativePath in interface InputFile
    
    Specified by:
    
    relativePath in interface InputPath
    
    See Also:
    
    InputFile.relativePath(), InputDir.relativePath()
  - getModuleRelativePath
```
public String getModuleRelativePath()
```
  - getProjectRelativePath
```
public String getProjectRelativePath()
```
  - absolutePath
```
public String absolutePath()
```
    Description copied from interface: InputFile
    
    Normalized absolute path. File separator is forward slash ('/'), even on Microsoft Windows.
    This is not canonical path. Symbolic links are not resolved. For example if /project/src links to /tmp/src and basedir is /project, then this method returns /project/src/index.php. Use file().getCanonicalPath() to resolve symbolic link.
    
    Specified by:
    
    absolutePath in interface IndexedFile
    
    Specified by:
    
    absolutePath in interface InputFile
    
    Specified by:
    
    absolutePath in interface InputPath
    
    See Also:
    
    InputFile.absolutePath(), InputDir.absolutePath()
  - file
```
public File file()
```
    Description copied from interface: InputFile
    
    The underlying absolute File. It should not be used to read the file in the filesystem.
    
    Specified by:
    
    file in interface IndexedFile
    
    Specified by:
    
    file in interface InputFile
    
    Specified by:
    
    file in interface InputPath
    
    See Also:
    
    InputFile.contents(), InputFile.inputStream()
  - path
```
public Path path()
```
    Description copied from interface: InputFile
    
    The underlying absolute Path. It should not be used to read the file in the filesystem.
    
    Specified by:
    
    path in interface IndexedFile
    
    Specified by:
    
    path in interface InputFile
    
    Specified by:
    
    path in interface InputPath
    
    See Also:
    
    InputFile.contents(), InputFile.inputStream()
  - language
```
@CheckForNull
public String language()
```
    Description copied from interface: InputFile
    
    Language, for example "java" or "php". Can be null if indexation of all files is enabled and no language claims to support the file.
    
    Specified by:
    
    language in interface IndexedFile
    
    Specified by:
    
    language in interface InputFile
  - type
```
public InputFile.Type type()
```
    Description copied from interface: InputFile
    
    Does it contain main or test code ?
    
    Specified by:
    
    type in interface IndexedFile
    
    Specified by:
    
    type in interface InputFile
  - key
```
public String key()
```
    Component key (without branch).
    
    Specified by:
    
    key in interface InputComponent
  - moduleKey
```
public String moduleKey()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class DefaultInputComponent
  - toString
```
public String toString()
```
    Description copied from interface: InputFile
    
    Return a string to identify this file (suitable for logs).
    
    Specified by:
    
    toString in interface InputFile
    
    Overrides:
    
    toString in class DefaultInputComponent
  - status
```
public InputFile.Status status()
```
    setStatus(org.sonar.api.batch.fs.InputFile.Status)
    
    Specified by:
    
    status in interface InputFile
  - lines
```
public int lines()
```
    Description copied from interface: InputFile
    
    Number of physical lines. This method supports all end-of-line characters. Formula is (number of line break + 1).
    Returns 1 if the file is empty.
    Returns 2 for foo\nbar.
    Returns 3 for foo\nbar\n.
    
    Specified by:
    
    lines in interface InputFile
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: InputFile
    
    Check if the file content is empty (ignore potential BOM).
    
    Specified by:
    
    isEmpty in interface InputFile
  - charset
```
public Charset charset()
```
    Description copied from interface: InputFile
    
    Charset to be used to decode this specific file.
    
    Specified by:
    
    charset in interface InputFile
  - lastValidOffset
```
public int lastValidOffset()
```
  - hash
```
public String hash()
```
    Digest hash of the file.
  - nonBlankLines
```
public int nonBlankLines()
```
  - originalLineOffsets
```
public int[] originalLineOffsets()
```
  - newPointer
```
public TextPointer newPointer(int line,
                              int lineOffset)
```
    Description copied from interface: InputFile
    
    Returns a TextPointer in the given file.
    
    Specified by:
    
    newPointer in interface InputFile
    
    Parameters:
    
    line - Line of the pointer. Start at 1.
    
    lineOffset - Offset in the line. Start at 0.
  - newRange
```
public TextRange newRange(TextPointer start,
                          TextPointer end)
```
    Description copied from interface: InputFile
    
    Returns a TextRange in the given file.
    
    Specified by:
    
    newRange in interface InputFile
    
    Parameters:
    
    start - start pointer
    
    end - end pointer
  - newRange
```
public TextRange newRange(int startLine,
                          int startLineOffset,
                          int endLine,
                          int endLineOffset)
```
    Description copied from interface: InputFile
    Returns a TextRange in the given file.
    - newRange(1, 0, 1, 1) selects the first character at line 1
    - newRange(1, 0, 1, 10) selects the 10 first characters at line 1
    Specified by:
    
    newRange in interface InputFile
  - selectLine
```
public TextRange selectLine(int line)
```
    Description copied from interface: InputFile
    
    Returns a TextRange in the given file that select the full line.
    
    Specified by:
    
    selectLine in interface InputFile
    
    Parameters:
    
    line - Start at 1.
  - validate
```
public void validate(TextRange range)
```
  - newRange
```
public TextRange newRange(int startOffset,
                          int endOffset)
```
    Create Range from global offsets. Used for backward compatibility with older API.
  - newPointer
```
public TextPointer newPointer(int globalOffset)
```
  - setStatus
```
public DefaultInputFile setStatus(InputFile.Status status)
```
  - setCharset
```
public DefaultInputFile setCharset(Charset charset)
```
  - setMetadata
```
public DefaultInputFile setMetadata(Metadata metadata)
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class DefaultInputComponent
  - isFile
```
public boolean isFile()
```
    Description copied from interface: InputComponent
    
    Is the component an InputFile
    
    Specified by:
    
    isFile in interface InputComponent
  - filename
```
public String filename()
```
    Description copied from interface: IndexedFile
    
    Filename for this file (inclusing extension). For example: MyClass.java.
    
    Specified by:
    
    filename in interface IndexedFile
  - uri
```
public URI uri()
```
    Description copied from interface: IndexedFile
    
    Identifier of the file. The only guarantee is that it is unique in the project. You should not assume it is a file:// URI.
    
    Specified by:
    
    uri in interface IndexedFile
    
    Specified by:
    
    uri in interface InputPath

Class DefaultInputFile

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.api.batch.fs.InputFile

Constructor Summary

Method Summary

Methods inherited from class org.sonar.api.batch.fs.internal.DefaultInputComponent

Methods inherited from class java.lang.Object

Constructor Detail

DefaultInputFile

DefaultInputFile

Method Detail

checkMetadata

inputStream

contents

setPublished

isPublished

setExcludedForCoverage

isExcludedForCoverage

relativePath

getModuleRelativePath

getProjectRelativePath

absolutePath

file

path

language

type

key

moduleKey

hashCode

toString

status

lines

isEmpty

charset

lastValidOffset

hash

nonBlankLines

originalLineOffsets

newPointer

newRange

newRange

selectLine

validate

newRange

newPointer

setStatus

setCharset

setMetadata

equals

isFile

filename

uri