jp.ikedam.jenkins.plugins.extensible_choice_parameter
クラス FilenameChoiceListProvider

java.lang.Object
  hudson.model.AbstractDescribableImpl<ChoiceListProvider>
      jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider
          jp.ikedam.jenkins.plugins.extensible_choice_parameter.FilenameChoiceListProvider

すべての実装されたインタフェース:

hudson.ExtensionPoint, hudson.model.Describable<ChoiceListProvider>, Serializable

public class FilenameChoiceListProvider
extends ChoiceListProvider
implements Serializable

Create a choice list from a list of files.

関連項目:

直列化された形式

入れ子のクラスの概要

static class	FilenameChoiceListProvider.DescriptorImpl Class for view.
static class	FilenameChoiceListProvider.EmptyChoiceType
static class	FilenameChoiceListProvider.ScanType A type specifying what type of files to scan to list.

インタフェース hudson.ExtensionPoint から継承された入れ子のクラス/インタフェース

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

コンストラクタの概要

FilenameChoiceListProvider(String baseDirPath, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType)
推奨されていません。 use FilenameChoiceListProvider(String, String, String, ScanType, boolean)

FilenameChoiceListProvider(String baseDirPath, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType, boolean reverseOrder)
推奨されていません。

FilenameChoiceListProvider(String baseDirPath, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType, boolean reverseOrder, FilenameChoiceListProvider.EmptyChoiceType emptyChoiceType)
The constructor called when a user posts a form.

メソッドの概要

protected File	getBaseDir() Returns a directory to scan for files.
protected static File	getBaseDir(String baseDirPath) Returns a directory to scan for files from the passed path.
String	getBaseDirPath() Returns a path to a directory to scan for files.
List<String>	getChoiceList() Returns the list of choices to show.
FilenameChoiceListProvider.EmptyChoiceType	getEmptyChoiceType()
String	getExcludePattern() Returns a pattern for files to exclude.
protected static List<String>	getFileList(File baseDir, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType) 推奨されていません。 use getFileList(File, String, String, ScanType, boolean)
protected static List<String>	getFileList(File baseDir, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType, boolean reverseOrder) 推奨されていません。
protected static List<String>	getFileList(File baseDir, String includePattern, String excludePattern, FilenameChoiceListProvider.ScanType scanType, boolean reverseOrder, FilenameChoiceListProvider.EmptyChoiceType emptyChoiceType) List files from passed parameters.
String	getIncludePattern() Returns a pattern for files to include.
FilenameChoiceListProvider.ScanType	getScanType() Returns what type of files to list.
boolean	isReverseOrder()

クラス jp.ikedam.jenkins.plugins.extensible_choice_parameter.ChoiceListProvider から継承されたメソッド

all, getDefaultChoice, onBuildCompletedWithValue, onBuildTriggeredWithValue

クラス hudson.model.AbstractDescribableImpl から継承されたメソッド

getDescriptor

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

FilenameChoiceListProvider

@DataBoundConstructor
public FilenameChoiceListProvider(String baseDirPath,
                                                       String includePattern,
                                                       String excludePattern,
                                                       FilenameChoiceListProvider.ScanType scanType,
                                                       boolean reverseOrder,
                                                       FilenameChoiceListProvider.EmptyChoiceType emptyChoiceType)

The constructor called when a user posts a form.

パラメータ:

baseDirPath - a path to the directory to scan.

includePattern - a pattern of file names to include to the list.

excludePattern - a pattern of file names to exclude from the list.

scanType - a type of files to list.

emptyChoiceType - whether and where to put an empty choice.

FilenameChoiceListProvider

@Deprecated
public FilenameChoiceListProvider(String baseDirPath,
                                             String includePattern,
                                             String excludePattern,
                                             FilenameChoiceListProvider.ScanType scanType,
                                             boolean reverseOrder)

推奨されていません。

FilenameChoiceListProvider

@Deprecated
public FilenameChoiceListProvider(String baseDirPath,
                                             String includePattern,
                                             String excludePattern,
                                             FilenameChoiceListProvider.ScanType scanType)

推奨されていません。 use FilenameChoiceListProvider(String, String, String, ScanType, boolean)

For backward compatibility.

パラメータ:

baseDirPath -

includePattern -

excludePattern -

scanType -

メソッドの詳細

getBaseDirPath

public String getBaseDirPath()

Returns a path to a directory to scan for files. If this path is absolute, it is used as specified. If this path is relative, it is considered relative from JENKINS_HOME.

戻り値:

the baseDirPath

getBaseDir

protected static File getBaseDir(String baseDirPath)

Returns a directory to scan for files from the passed path. Whether the path is relative or absolute, is resolved here.

パラメータ:

baseDirPath - a path string to the directory.

戻り値:

A file object specifying the proper path of the directory.

getBaseDir

protected File getBaseDir()

Returns a directory to scan for files.

戻り値:

A file object specifying the proper path to the directory to scan.

getIncludePattern

public String getIncludePattern()

Returns a pattern for files to include.

戻り値:

the include pattern

getScanType

public FilenameChoiceListProvider.ScanType getScanType()

Returns what type of files to list.

戻り値:

what type of files to list

getExcludePattern

public String getExcludePattern()

Returns a pattern for files to exclude.

戻り値:

the exclude pattern

isReverseOrder

public boolean isReverseOrder()

戻り値:

getEmptyChoiceType

public FilenameChoiceListProvider.EmptyChoiceType getEmptyChoiceType()

戻り値:

whether and where to put an empty choice.

getFileList

protected static List<String> getFileList(File baseDir,
                                          String includePattern,
                                          String excludePattern,
                                          FilenameChoiceListProvider.ScanType scanType,
                                          boolean reverseOrder,
                                          FilenameChoiceListProvider.EmptyChoiceType emptyChoiceType)

List files from passed parameters.

パラメータ:

baseDir -

includePattern -

excludePattern -

scanType -

reverseOrder -

戻り値:

getFileList

@Deprecated
protected static List<String> getFileList(File baseDir,
                                                     String includePattern,
                                                     String excludePattern,
                                                     FilenameChoiceListProvider.ScanType scanType,
                                                     boolean reverseOrder)

推奨されていません。

getFileList

@Deprecated
protected static List<String> getFileList(File baseDir,
                                                     String includePattern,
                                                     String excludePattern,
                                                     FilenameChoiceListProvider.ScanType scanType)

推奨されていません。 use getFileList(File, String, String, ScanType, boolean)

For backward compatibility.

パラメータ:

baseDir -

includePattern -

excludePattern -

scanType -

戻り値:

getChoiceList

public List<String> getChoiceList()

Returns the list of choices to show.

定義:

クラス ChoiceListProvider 内の getChoiceList

戻り値:

関連項目:

ChoiceListProvider.getChoiceList()