Package com.cloudbees.jenkins.support.filter

Class ContentMappings

java.lang.Object

hudson.model.ManagementLink

com.cloudbees.jenkins.support.filter.ContentMappings

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, Saveable, Iterable<ContentMapping>

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public class ContentMappings
extends ManagementLink
implements Saveable, Iterable<ContentMapping>

Holds all anonymized content mappings and provides a management view to see those mappings.

Since:

TODO

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.ManagementLink

ManagementLink.Category

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.ManagementLink

LIST

Fields inherited from interface hudson.model.Saveable

NOOP

Method Summary

Modifier and Type	Method	Description
protected void	clear()
void	forEach(Consumer<? super ContentMapping> action)
static ContentMappings	get()
ManagementLink.Category	getCategory()
String	getDescription()
String	getDisplayName()
String	getIconFileName()
ContentMapping	getMappingOrCreate(String original, Function<String,ContentMapping> generator)	Looks up or creates a new ContentMapping for the given original string and a ContentMapping generator.
Map<String,String>	getMappings()
Set<String>	getStopWords()
String	getUrlName()
Iterator<ContentMapping>	iterator()
static ContentMappings	newInstance()	Constructs a new ContentMappings using an existing config file or default settings if not found.
void	reload()
void	save()
Spliterator<ContentMapping>	spliterator()

Methods inherited from class hudson.model.ManagementLink

all, getBadge, getCategoryName, getRequiredPermission, getRequiresConfirmation, getRequiresPOST

Methods inherited from class java.lang.Object

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

Method Details

get

public static ContentMappings get()

Returns:

the singleton instance

newInstance

@Extension
public static ContentMappings newInstance()
                                   throws IOException

Constructs a new ContentMappings using an existing config file or default settings if not found.

Throws:

IOException

getStopWords

@NonNull
public Set<String> getStopWords()

Returns:

the set of stop words to ignore when filtering

getMappings

@NonNull
public Map<String,String> getMappings()

Returns:

the map of original to replacement values known to this instance

getMappingOrCreate

@NonNull
public ContentMapping getMappingOrCreate(@NonNull
 String original,
 @NonNull
 Function<String,ContentMapping> generator)

Looks up or creates a new ContentMapping for the given original string and a ContentMapping generator.

reload

public void reload()

clear

protected void clear()

save

public void save()
          throws IOException

Specified by:

save in interface Saveable

Throws:

IOException

iterator

@NonNull
public Iterator<ContentMapping> iterator()

Specified by:

iterator in interface Iterable<ContentMapping>

forEach

public void forEach(Consumer<? super ContentMapping> action)

Specified by:

forEach in interface Iterable<ContentMapping>

spliterator

public Spliterator<ContentMapping> spliterator()

Specified by:

spliterator in interface Iterable<ContentMapping>

getIconFileName

@NonNull
public String getIconFileName()

Specified by:

getIconFileName in interface Action

Specified by:

getIconFileName in class ManagementLink

getDisplayName

@NonNull
public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getDescription

public String getDescription()

Overrides:

getDescription in class ManagementLink

getUrlName

@NonNull
public String getUrlName()

Specified by:

getUrlName in interface Action

Specified by:

getUrlName in class ManagementLink

getCategory

@NonNull
public ManagementLink.Category getCategory()

Overrides:

getCategory in class ManagementLink