@MetaInfServices public class ViewOptionHandler extends org.kohsuke.args4j.spi.OptionHandler<View>
View
by its name.
For example:
inner
inside of a top level view group named nested
.
View name is a non-empty sequence of View
names delimited by '/'.
Handler traverse the view names from left to right. First one is expected to
be a top level view and all but the last one are expected to be instances of
ViewGroup
. Handler fails to resolve view provided a view with given
name does not exist or a user was not granted View.READ
permission.
Constructor and Description |
---|
ViewOptionHandler(org.kohsuke.args4j.CmdLineParser parser,
org.kohsuke.args4j.OptionDef option,
org.kohsuke.args4j.spi.Setter<View> setter) |
Modifier and Type | Method and Description |
---|---|
String |
getDefaultMetaVariable() |
View |
getView(String name)
Gets a view by its name
Note: Personal user's views aren't supported now.
|
int |
parseArguments(org.kohsuke.args4j.spi.Parameters params) |
public ViewOptionHandler(org.kohsuke.args4j.CmdLineParser parser, org.kohsuke.args4j.OptionDef option, org.kohsuke.args4j.spi.Setter<View> setter)
public int parseArguments(org.kohsuke.args4j.spi.Parameters params) throws org.kohsuke.args4j.CmdLineException
parseArguments
in class org.kohsuke.args4j.spi.OptionHandler<View>
org.kohsuke.args4j.CmdLineException
@CheckForNull public View getView(String name)
name
- A view nameView
instance. Null if name is empty stringIllegalArgumentException
- If the view isn't foundIllegalStateException
- If cannot get active Jenkins instance or view can't contain a viewsorg.springframework.security.access.AccessDeniedException
- If user doesn't have a READ permission for the viewCopyright © 2004–2021. All rights reserved.