Package org.jvnet.hudson.plugins.collapsingconsolesections

Class SectionDefinition

java.lang.Object

org.jvnet.hudson.plugins.collapsingconsolesections.SectionDefinition

All Implemented Interfaces:

Serializable

public class SectionDefinition
extends Object
implements Serializable

Author:

dty

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern)	Deprecated. Use SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean) instead.
SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel)	Deprecated. Use SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean) instead.
SectionDefinition(String sectionName, String sectionStartPattern, String sectionEndPattern, boolean collapseOnlyOneLevel, boolean collapseSection)	Creates a new section definition.

Method Summary

Modifier and Type	Method	Description
String	getSectionDisplayName()
String	getSectionDisplayName(Matcher m)
Pattern	getSectionEndPattern()
Pattern	getSectionStartPattern()
boolean	isCollapseOnlyOneLevel()
boolean	isCollapseSection()

Methods inherited from class java.lang.Object

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

Constructor Details

SectionDefinition

@Deprecated
public SectionDefinition(String sectionName,
 String sectionStartPattern,
 String sectionEndPattern)

Deprecated.

Use SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean) instead.

SectionDefinition

@Deprecated
public SectionDefinition(String sectionName,
 String sectionStartPattern,
 String sectionEndPattern,
 boolean collapseOnlyOneLevel)

Deprecated.

Use SectionDefinition(java.lang.String, java.lang.String, java.lang.String, boolean, boolean) instead.

SectionDefinition

public SectionDefinition(@Nonnull
 String sectionName,
 @Nonnull
 String sectionStartPattern,
 @Nonnull
 String sectionEndPattern,
 boolean collapseOnlyOneLevel,
 boolean collapseSection)
                  throws PatternSyntaxException

Creates a new section definition.

Parameters:

sectionName - Name of the section

sectionStartPattern - Regular expression pattern for the section start

sectionEndPattern - Regular expression pattern for the section end

collapseOnlyOneLevel - If true, only one level will be collapsed by the end pattern

collapseSection - If true, the section should be collapsed by default

Throws:

PatternSyntaxException - One of the patterns is invalid

Method Details

getSectionDisplayName

@Nonnull
public String getSectionDisplayName()

getSectionDisplayName

@Nonnull
public String getSectionDisplayName(@Nonnull
 Matcher m)

getSectionStartPattern

@Nonnull
public Pattern getSectionStartPattern()

getSectionEndPattern

@Nonnull
public Pattern getSectionEndPattern()

isCollapseSection

public boolean isCollapseSection()

isCollapseOnlyOneLevel

public boolean isCollapseOnlyOneLevel()