com.cloudbees.hudson.plugins.folder.views

Class AbstractFolderViewHolder

java.lang.Object

com.cloudbees.hudson.plugins.folder.views.AbstractFolderViewHolder

Direct Known Subclasses:

DefaultFolderViewHolder

public abstract class AbstractFolderViewHolder
extends Object

Responsible for holding the view configuration of an AbstractFolder. Each AbstractFolder concrete type should define its view configuration holder by returning the implementation from AbstractFolder.newFolderViewHolder() Use-cases:

• Where the AbstractFolder permits the views to be configured by the user, use a DefaultFolderViewHolder
• Where the AbstractFolder has a fixed set of pre-configured views, the plugin can provide a custom implementation that returns the fixed set of views.

Since:

FIXME

Constructor Summary

Constructors

Constructor and Description
AbstractFolderViewHolder()

Method Summary

Modifier and Type	Method and Description
abstract String	getPrimaryView() Returns the View.getViewName() of the primary view or null if the first view should be primary.
abstract hudson.views.ViewsTabBar	getTabBar() Returns the ViewsTabBar.
abstract List<hudson.model.View>	getViews() Returns the list of views.
void	invalidateCaches() Called by AbstractFolder.save() to signal that the view holder should clear any internal state caches.
boolean	isPrimaryModifiable() Returns true if the primary View is modifiable.
boolean	isTabBarModifiable() Returns true if the ViewsTabBar is modifiable.
boolean	isViewsModifiable() Returns true if the list of views is modifiable.
abstract void	setPrimaryView(String name) Changes the primary View.
abstract void	setTabBar(hudson.views.ViewsTabBar tabBar) Changes the ViewsTabBar.
abstract void	setViews(List<? extends hudson.model.View> views) Changes the list of Views.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFolderViewHolder

public AbstractFolderViewHolder()

Method Detail

getViews

@NonNull
public abstract List<hudson.model.View> getViews()

Returns the list of views. If isViewsModifiable() then this list is modifiable.

Returns:

the list of views.

setViews

public abstract void setViews(@NonNull
                              List<? extends hudson.model.View> views)

Changes the list of Views. May be a no-op if isViewsModifiable() returns false.

Parameters:

views - the new list of Views.

See Also:

isViewsModifiable()

isViewsModifiable

public boolean isViewsModifiable()

Returns true if the list of views is modifiable.

Returns:

true if the list of views is modifiable.

getPrimaryView

@CheckForNull
public abstract String getPrimaryView()

Returns the View.getViewName() of the primary view or null if the first view should be primary.

Returns:

the View.getViewName() of the primary view or null if the first view should be primary.

setPrimaryView

public abstract void setPrimaryView(@CheckForNull
                                    String name)

Changes the primary View. May be a no-op if isPrimaryModifiable() returns false.

Parameters:

name - the View.getViewName() of the primary View of null to use the first view.

See Also:

isPrimaryModifiable()

isPrimaryModifiable

public boolean isPrimaryModifiable()

Returns true if the primary View is modifiable.

Returns:

true if the primary View is modifiable.

getTabBar

@NonNull
public abstract hudson.views.ViewsTabBar getTabBar()

Returns the ViewsTabBar.

Returns:

the ViewsTabBar.

setTabBar

public abstract void setTabBar(@NonNull
                               hudson.views.ViewsTabBar tabBar)

Changes the ViewsTabBar. May be a no-op if isTabBarModifiable() returns false.

Parameters:

tabBar - the new ViewsTabBar.

See Also:

isTabBarModifiable()

isTabBarModifiable

public boolean isTabBarModifiable()

Returns true if the ViewsTabBar is modifiable.

Returns:

true if the ViewsTabBar is modifiable.

invalidateCaches

public void invalidateCaches()

Called by AbstractFolder.save() to signal that the view holder should clear any internal state caches.