Package io.github.diltdicker.codelog.type

Class Change

java.lang.Object

io.github.diltdicker.codelog.type.Change

public class Change
extends Object

Change Object class. Can be serialized to a .yaml file for change tracking across branches

Field Summary

Fields

Modifier and Type	Field	Description
String	comment	Summary notes of the change that is being logged
String	id	Issue id/number or ticket number uniquely identifying particular change
ChangeType	type	Category of change being logged [ New | Fix | Change | Documentation | Break ]

Constructor Summary

Constructors

Constructor	Description
Change()	Empty constructor intended to be used by Jackson-yaml
Change(String id, String type, String comment)	Change constructor for creating a complete Change object

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

id

public String id

Issue id/number or ticket number uniquely identifying particular change

comment

public String comment

Summary notes of the change that is being logged

type

public ChangeType type

Category of change being logged [ New | Fix | Change | Documentation | Break ]

Constructor Details

Change

public Change()

Empty constructor intended to be used by Jackson-yaml

Change

public Change(String id,
 String type,
 String comment)

Change constructor for creating a complete Change object

Parameters:

id - change id field

type - change type field

comment - change comment field