org.jenkinsci.plugins.IBM_zOS_Connector

Class SCLMFileState

java.lang.Object

org.jenkinsci.plugins.IBM_zOS_Connector.SCLMFileState

public class SCLMFileState
extends Object

SCLMFileState

Class describing file from SCLM.

Version:

1.0

Author:

Alexander Shcherbakov

Field Summary

Fields

Modifier and Type	Field and Description
String	alternate SCLM Alternate Project Definition.
static Comparator<SCLMFileState>	ChangeComparator Comparator for changes sorting.
Date	changeDate Change Date and Time.
String	changeGroup Change Group.
String	changeUserID Change User ID.
static SimpleDateFormat	DateFormat Format for date printing.
hudson.scm.EditType	editType Edit Type (not regarded during comparison).
String	group SCLM Group.
String	name Member Name.
String	project SCLM Project Name.
String	type Member Type.
long	version Member version.

Constructor Summary

Constructors

Constructor and Description
SCLMFileState() Dummy constructor.
SCLMFileState(String project, String alternate, String group, String type, String name, long version, Date changeDate, String changeUserID, String changeGroup) Full constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SCLMFileState e) This function is later used for removing duplicates.
boolean	equals(Object o) Used for removing duplicate files (matching paths).
String	getPath() Printable path.
String	toString() Simple toString method.

Methods inherited from class java.lang.Object

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

Field Detail

project

public String project

SCLM Project Name. Equivalent to @@FLMPRJ.

alternate

public String alternate

SCLM Alternate Project Definition. Equivalent to @@FLMALT.

group

public String group

SCLM Group. Equivalent to @@FLMGRP.

type

public String type

Member Type. Equivalent to @@FLMTYP.

name

public String name

Member Name. Equivalent to @@FLMMBR.

version

public long version

Member version. Equivalent to @@FLMMVR.

changeDate

public Date changeDate

Change Date and Time. Equivalent to combination of @@FLMCD4 and @@FLMCTM.

changeUserID

public String changeUserID

Change User ID. Equivalent to @@FLMCUS.

changeGroup

public String changeGroup

Change Group. Equivalent to @@FLMCLV.

editType

public hudson.scm.EditType editType

Edit Type (not regarded during comparison).

DateFormat

public static final SimpleDateFormat DateFormat

Format for date printing.

ChangeComparator

public static Comparator<SCLMFileState> ChangeComparator

Comparator for changes sorting.
1. Change Date and Time (descending)
2. Type
3. Name
4. Version (descending)
5. Change User ID
6. Change Group

Constructor Detail

SCLMFileState

public SCLMFileState()

Dummy constructor.

SCLMFileState

public SCLMFileState(String project,
                     String alternate,
                     String group,
                     String type,
                     String name,
                     long version,
                     Date changeDate,
                     String changeUserID,
                     String changeGroup)

Full constructor.

Parameters:

project - SCLM Project Name.

alternate - SCLM Alternate Project Definition.

group - SCLM Group.

type - SCLM file type.

name - SCLM member name.

version - SCLM member version.

changeDate - Last Change Date.

changeUserID - User ID of the last changer.

changeGroup - SCLM Change Group.

Method Detail

compareTo

public int compareTo(SCLMFileState e)

This function is later used for removing duplicates.
The order of comparison:
1. Project
2. Alternate
3. Group
4. Type
5. Name
6. Version
7. Change Date and time
8. Change UserID
9. Change Group

Parameters:

e - the SCLMAffectedFile object we are comparing to.

Returns:

-1:0:1 depending on the compare result.

toString

public String toString()

Simple toString method.

Overrides:

toString in class Object

Returns:

printable representation of SCLMFileState.

getPath

public String getPath()

Printable path.

Returns:

Printable path for SCLM file.

equals

public boolean equals(Object o)

Used for removing duplicate files (matching paths).

Overrides:

equals in class Object

Parameters:

o - Object for comparison.

Returns:

Whether the files are at the same location.