FileContent (Support Core Plugin 1266.v6d096c154c90 API)

java.lang.Object
- com.cloudbees.jenkins.support.api.Content
- - com.cloudbees.jenkins.support.filter.PrefilteredContent
  - - com.cloudbees.jenkins.support.api.FileContent

Direct Known Subclasses:

LaunchLogsFileContent, TemporaryFileContent
```
public class FileContent
extends PrefilteredContent
```
Content that is stored as a file on disk. The content is filtered with the ContentFilter defined in the instance.

Author:

Stephen Connolly

Field Summary

Fields
Modifier and Type Field Description

protected com.cloudbees.jenkins.support.api.BaseFileContent baseFileContent

protected File file

Constructor Summary

Constructors
Constructor	Description
`FileContent(String name, File file)`
`FileContent(String name, File file, long maxSize)`
`FileContent(String name, String[] filterableParameters, File file)`
`FileContent(String name, String[] filterableParameters, File file, long maxSize)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected InputStream`	`getInputStream()`	Instantiates the `InputStream` for the `file`.
`protected String`	`getSimpleValueOrRedactedPassword(String value)`
`long`	`getTime()`
`void`	`writeTo(OutputStream os)`
`void`	`writeTo(OutputStream os, ContentFilter filter)`	Write the component in the bundle filtering the content

Methods inherited from class com.cloudbees.jenkins.support.filter.PrefilteredContent
shouldBeFiltered

Methods inherited from class com.cloudbees.jenkins.support.api.Content
getFilterableParameters, getName

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

Field Detail

baseFileContent

protected com.cloudbees.jenkins.support.api.BaseFileContent baseFileContent

file
```
protected final File file
```

Constructor Detail

FileContent

public FileContent(String name,
                   File file)

FileContent

public FileContent(String name,
                   File file,
                   long maxSize)

FileContent

public FileContent(String name,
                   String[] filterableParameters,
                   File file)

FileContent

public FileContent(String name,
                   String[] filterableParameters,
                   File file,
                   long maxSize)

Method Detail
- writeTo
```
public void writeTo(OutputStream os)
             throws IOException
```
  Specified by:
  
  writeTo in class Content
  
  Throws:
  
  IOException
- writeTo
```
public void writeTo(OutputStream os,
                    ContentFilter filter)
             throws IOException
```
  Description copied from class: PrefilteredContent
  
  Write the component in the bundle filtering the content
  
  Specified by:
  
  writeTo in class PrefilteredContent
  
  Parameters:
  
  os - OutputStream where write the content
  
  filter - ContentFilter to apply
  
  Throws:
  
  IOException - If an input or output exception occurs
- getTime
```
public long getTime()
```
  Overrides:
  
  getTime in class Content
- getInputStream
```
protected InputStream getInputStream()
                              throws IOException
```
  Instantiates the InputStream for the file.
  
  Returns:
  
  the InputStream for the file.
  
  Throws:
  
  IOException - if something goes wrong while creating the stream for reading #file.
- getSimpleValueOrRedactedPassword
```
protected String getSimpleValueOrRedactedPassword(String value)
```