DefaultInputFile (SonarQube :: Plugin API 5.6.7 API)

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

All Implemented Interfaces:: InputComponent, InputPath, InputFile

public class DefaultInputFile
extends DefaultInputComponent
implements InputFile, InputFile

Since:: 4.2

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(String moduleKey, String relativePath)

Constructors
Constructor and Description
`DefaultInputFile(String moduleKey, String relativePath)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`absolutePath()` Normalized absolute path.
`Charset`	`charset()`
`boolean`	`equals(Object o)`
`File`	`file()` The underlying absolute `File`
`File`	`getFile()` Get the underlying file.
`File`	`getFileBaseDir()` The source base directory, different than the project basedir.
`InputStream`	`getInputStream()` Get an `InputStream` that reads from the file.
`String`	`getRelativePath()` Path relative to basedir.
`String`	`hash()` Digest hash of the file.
`int`	`hashCode()`
`DefaultInputFile`	`initMetadata(FileMetadata.Metadata metadata)`
`DefaultInputFile`	`initMetadata(String content)` For testing purpose
`boolean`	`isEmpty()` Check if the file content is empty (ignore potential BOM).
`boolean`	`isFile()` Is the component an `InputFile`
`String`	`key()` Component key.
`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()` Path relative to module base directory.
`TextRange`	`selectLine(int line)` Returns a `TextRange` in the given file that select the full line.
`DefaultInputFile`	`setCharset(Charset charset)`
`DefaultInputFile`	`setHash(String hash)`
`DefaultInputFile`	`setLanguage(String language)`
`DefaultInputFile`	`setLastValidOffset(int lastValidOffset)`
`DefaultInputFile`	`setLines(int lines)`
`DefaultInputFile`	`setModuleBaseDir(Path moduleBaseDir)` For testing purpose.
`DefaultInputFile`	`setNonBlankLines(int nonBlankLines)`
`DefaultInputFile`	`setOriginalLineOffsets(int[] originalLineOffsets)`
`DefaultInputFile`	`setStatus(InputFile.Status status)`
`DefaultInputFile`	`setType(InputFile.Type type)`
`InputFile.Status`	`status()` `setStatus(org.sonar.api.batch.fs.InputFile.Status)`
`String`	`toString()`
`InputFile.Type`	`type()` Does it contain main or test code ?
`void`	`validate(TextRange range)`

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

- Constructor Detail
  - DefaultInputFile
```
public DefaultInputFile(String moduleKey,
                        String relativePath)
```
- Method Detail
  - relativePath
```
public String relativePath()
```
    Description copied from interface: InputFile
    
    Path relative to module base directory. Path is unique and identifies file within given FileSystem. 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 InputPath
    
    See Also:
    
    InputFile.relativePath(), InputDir.relativePath()
  - 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 InputPath
    
    See Also:
    
    InputFile.absolutePath(), InputDir.absolutePath()
  - file
```
public File file()
```
    Description copied from interface: InputFile
    
    The underlying absolute File
    
    Specified by:
    
    file in interface InputPath
    
    See Also:
    
    InputFile.file(), InputDir.file()
  - path
```
public Path path()
```
    Description copied from interface: InputFile
    
    The underlying absolute Path
    
    Specified by:
    
    path in interface InputPath
    
    See Also:
    
    InputFile.path(), InputDir.path()
  - 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.
  - type
```
public InputFile.Type type()
```
    Description copied from interface: InputFile
    
    Does it contain main or test code ?
  - status
```
public InputFile.Status status()
```
    setStatus(org.sonar.api.batch.fs.InputFile.Status)
  - 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.
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: InputFile
    
    Check if the file content is empty (ignore potential BOM).
  - key
```
public String key()
```
    Component key.
    
    Specified by:
    
    key in interface InputComponent
  - moduleKey
```
public String moduleKey()
```
  - charset
```
public Charset charset()
```
  - setModuleBaseDir
```
public DefaultInputFile setModuleBaseDir(Path moduleBaseDir)
```
    For testing purpose. Will be automaticall set when file is added to DefaultFileSystem
  - setLanguage
```
public DefaultInputFile setLanguage(@Nullable
                                    String language)
```
  - setType
```
public DefaultInputFile setType(InputFile.Type type)
```
  - setStatus
```
public DefaultInputFile setStatus(InputFile.Status status)
```
  - setLines
```
public DefaultInputFile setLines(int lines)
```
  - setCharset
```
public DefaultInputFile setCharset(Charset charset)
```
  - lastValidOffset
```
public int lastValidOffset()
```
  - setLastValidOffset
```
public DefaultInputFile setLastValidOffset(int lastValidOffset)
```
  - hash
```
public String hash()
```
    Digest hash of the file.
  - nonBlankLines
```
public int nonBlankLines()
```
  - originalLineOffsets
```
public int[] originalLineOffsets()
```
  - setHash
```
public DefaultInputFile setHash(String hash)
```
  - setNonBlankLines
```
public DefaultInputFile setNonBlankLines(int nonBlankLines)
```
  - setOriginalLineOffsets
```
public DefaultInputFile setOriginalLineOffsets(int[] originalLineOffsets)
```
  - newPointer
```
public TextPointer newPointer(int line,
                              int lineOffset)
```
    Description copied from interface: InputFile
    
    Returns a TextPointer in the given file.
    
    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.
    
    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
  - selectLine
```
public TextRange selectLine(int line)
```
    Description copied from interface: InputFile
    
    Returns a TextRange in the given file that select the full line.
    
    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)
```
  - initMetadata
```
public DefaultInputFile initMetadata(FileMetadata.Metadata metadata)
```
  - initMetadata
```
public DefaultInputFile initMetadata(String content)
```
    For testing purpose
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class DefaultInputComponent
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class DefaultInputComponent
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class DefaultInputComponent
  - getFileBaseDir
```
public File getFileBaseDir()
```
    Description copied from interface: InputFile
    
    The source base directory, different than the project basedir.
    For example in maven projects, the basedir of a source file stored in src/main/java/org/foo/ is the directory src/main/java.
    
    Specified by:
    
    getFileBaseDir in interface InputFile
  - getFile
```
public File getFile()
```
    Description copied from interface: InputFile
    
    Get the underlying file.
    
    Specified by:
    
    getFile in interface InputFile
    
    Returns:
    
    the file
  - getRelativePath
```
public String getRelativePath()
```
    Description copied from interface: InputFile
    
    Path relative to basedir. Directory separator is slash '/', whatever the platform.
    Example on windows: if file basedir is c:\project\src\ and file is c:\project\src\org\foo\Bar.java, then relative path is org/foo/Bar.java
    Example on unix: if file basedir is /project/src and file is /project/src/org/foo/Bar.java, then relative path is org/foo/Bar.java as well.
    
    Specified by:
    
    getRelativePath in interface InputFile
  - getInputStream
```
public InputStream getInputStream()
                           throws FileNotFoundException
```
    Description copied from interface: InputFile
    
    Get an InputStream that reads from the file.
    The returned stream is buffered so there is no need to use a BufferedInputStream
    
    Specified by:
    
    getInputStream in interface InputFile
    
    Returns:
    
    the stream
    
    Throws:
    
    FileNotFoundException - if the file is not found
  - isFile
```
public boolean isFile()
```
    Description copied from interface: InputComponent
    
    Is the component an InputFile
    
    Specified by:
    
    isFile in interface InputComponent

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 java.lang.Object

Constructor Detail

DefaultInputFile

Method Detail

relativePath

absolutePath

file

path

language

type

status

lines

isEmpty

key

moduleKey

charset

setModuleBaseDir

setLanguage

setType

setStatus

setLines

setCharset

lastValidOffset

setLastValidOffset

hash

nonBlankLines

originalLineOffsets

setHash

setNonBlankLines

setOriginalLineOffsets

newPointer

newRange

newRange

selectLine

validate

newRange

newPointer

initMetadata

initMetadata

equals

hashCode

toString

getFileBaseDir

getFile

getRelativePath

getInputStream

isFile