Package io.jenkins.blueocean.rest.model

Class Container<T>

java.lang.Object

io.jenkins.blueocean.rest.model.Container<T>

All Implemented Interfaces:

Pageable<T>, Reachable, Iterable<T>

Direct Known Subclasses:

BlueArtifactContainer, BlueFavoriteContainer, BlueOrganizationContainer, BluePipelineContainer, BluePipelineNodeContainer, BluePipelineStepContainer, BlueQueueContainer, BlueRunContainer, BlueTestResultContainer, BlueTrendContainer, BlueUserContainer, Containers.AbstractContainer

public abstract class Container<T>
extends Object
implements Pageable<T>, Reachable

Stapler-bound REST endpoint for a collection of objects.

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor	Description
Container()

Method Summary

Modifier and Type	Method	Description
abstract T	get(String name)	Gets the individual member by its name
final T	getDynamic(String name)
Iterator<T>	iterator(int start, int limit)	Base implementation of pagination that is dumb.
Pageable<T>	list()	When GET is requested on '/', serve the collection

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Constructor Details

Container

public Container()

Method Details

get

public abstract T get(String name)

Gets the individual member by its name

Parameters:

name - identifying the member

Returns:

individual member

getDynamic

public final T getDynamic(String name)

iterator

public Iterator<T> iterator(int start,
 int limit)

Base implementation of pagination that is dumb.

Specified by:

iterator in interface Pageable<T>

Parameters:

start - starting index requested from collection

limit - max number of item requested in the page

Returns:

filtered collection

list

@WebMethod(name="")
@GET
public Pageable<T> list()

When GET is requested on '/', serve the collection

Returns:

collection in this container