Package adams.flow.source.git

Class Log

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.git.AbstractGitOperation

adams.flow.source.git.Log

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable

public class Log
extends AbstractGitOperation

Performs git log on the specified dir/file.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Target	the file/dir to perform the log on.

Fields inherited from class adams.flow.source.git.AbstractGitOperation

m_GitOperation, m_GitRepo

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
Log()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected boolean	doCanExecute(adams.core.MessageCollection errors)	Checks whether the git operation can be executed.
protected Object	doExecute(adams.core.MessageCollection errors)	Executes the git operation.
Class[]	generates()	Returns the type of data of the output.
String	getTarget()	Returns the target to create the log for.
String	globalInfo()	Returns a string describing the object.
void	setTarget(String value)	Sets the target to create the log for.
String	targetTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.git.AbstractGitOperation

canExecute, check, execute, getGitRepo, getQuickInfo, requiresGitRepo, setGitRepo

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Target

protected String m_Target

the file/dir to perform the log on.

Constructor Detail

Log

public Log()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setTarget

public void setTarget(String value)

Sets the target to create the log for.

Parameters:

value - the dir/file

getTarget

public String getTarget()

Returns the target to create the log for.

Returns:

the dir/file

targetTipText

public String targetTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

generates

public Class[] generates()

Returns the type of data of the output.

Specified by:

generates in class AbstractGitOperation

Returns:

the type of data

doCanExecute

protected boolean doCanExecute(adams.core.MessageCollection errors)

Checks whether the git operation can be executed.

Specified by:

doCanExecute in class AbstractGitOperation

Parameters:

errors - for storing errors, can be null

Returns:

whether operation can be executed

doExecute

protected Object doExecute(adams.core.MessageCollection errors)

Executes the git operation.

Specified by:

doExecute in class AbstractGitOperation

Parameters:

errors - for storing errors, can be null

Returns:

the operation output, null if failed