Package com.cloudbees.jenkins.support.filter

Class PrefilteredContent

java.lang.Object

com.cloudbees.jenkins.support.api.Content

com.cloudbees.jenkins.support.filter.PrefilteredContent

Direct Known Subclasses:

FileContent, LogRecordContent, PrefilteredPrintedContent, StringContent

public abstract class PrefilteredContent
extends Content

Represents some content in a support bundle which will be filtered previously to the zip created.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrefilteredContent(String name)
protected	PrefilteredContent(String name, String... filterableParameters)

Method Summary

Modifier and Type	Method	Description
final boolean	shouldBeFiltered()	Indicates if this Content should be filtered when anonymization is enabled.
abstract void	writeTo(OutputStream os, ContentFilter filter)	Write the component in the bundle filtering the content

Methods inherited from class com.cloudbees.jenkins.support.api.Content

getFilterableParameters, getName, getTime, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

PrefilteredContent

protected PrefilteredContent(String name)

PrefilteredContent

protected PrefilteredContent(String name,
 String... filterableParameters)

Method Details

writeTo

public abstract void writeTo(OutputStream os,
 @NonNull
 ContentFilter filter)
                      throws IOException

Write the component in the bundle filtering the content

Parameters:

os - OutputStream where write the content

filter - ContentFilter to apply

Throws:

IOException - If an input or output exception occurs

shouldBeFiltered

public final boolean shouldBeFiltered()

Description copied from class: Content

Indicates if this Content should be filtered when anonymization is enabled. When true, the contents written via Content.writeTo(OutputStream) may be filtered by a ContentFilter. When false, the contents are written without any filtering applied.

Overrides:

shouldBeFiltered in class Content