Index

A B C D E F G H I L M O P S V W
All Classes and Interfaces|All Packages

A

AbstractPlugin<S extends PluginFeature> - Class in org.itsallcode.whiterabbit.api

Base class for plugins that support a defined PluginFeature.

AbstractPlugin(String, Class<S>) - Constructor for class org.itsallcode.whiterabbit.api.AbstractPlugin

Constructor.

ActivityData - Interface in org.itsallcode.whiterabbit.api.model

Model for a project activity on a given day including project id, duration and comment.

B

beginTask(String, int) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor

Notifies that the main task is beginning.

C

close() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

close() - Method in interface org.itsallcode.whiterabbit.api.Plugin

Called before closing the plugin.

config - Variable in class org.itsallcode.whiterabbit.api.AbstractPlugin

The plugin configuration.

createActivityData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory

createDayData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory

createInstance() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

Plugins must implement this and return a new instance of the PluginFeature type.

createMonthData() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage.ModelFactory

D

DayData - Interface in org.itsallcode.whiterabbit.api.model

Model class representing a day with date, time for begin and end of work, activities etc.

DayType - Enum Class in org.itsallcode.whiterabbit.api.model

The type of a day.

E

export(ProjectReport, ProgressMonitor) - Method in interface org.itsallcode.whiterabbit.api.features.ProjectReportExporter

Start the export.

F

FLEX_TIME - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Flex time, reduce overtime (not working)

G

getActivities() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getAvailableDataMonths() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage

getBegin() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getCategory() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance

getComment() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

getComment() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getComment() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay

getComments() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity

getCostCarrier() - Method in interface org.itsallcode.whiterabbit.api.model.Project

getDataDir() - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration

Get the Path to the data directory.

getDate() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance

getDate() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getDate() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay

getDays() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

getDays() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport

getDuration() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

getEnd() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getFeature(Class<T>) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

getFeature(Class<T>) - Method in interface org.itsallcode.whiterabbit.api.Plugin

Get an instance of the given feature type.

getHolidays(LocalDate) - Method in interface org.itsallcode.whiterabbit.api.features.Holidays

Get all holidays for a given date.

getId() - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

getId() - Method in interface org.itsallcode.whiterabbit.api.Plugin

The ID of this plugin.

getInterruption() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getLabel() - Method in interface org.itsallcode.whiterabbit.api.model.Project

getMandatoryValue(String) - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration

Get property pluginId.propertyName from the config file.

getModelFactory() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage

getMonth() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

getMonth() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport

getName() - Method in interface org.itsallcode.whiterabbit.api.features.Holidays.HolidayInstance

getOptionalValue(String) - Method in interface org.itsallcode.whiterabbit.api.PluginConfiguration

Get property pluginId.propertyName from the config file.

getOvertimePreviousMonth() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

getProject() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity

getProjectId() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

getProjectId() - Method in interface org.itsallcode.whiterabbit.api.model.Project

getProjects() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReport

getProjects() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay

getType() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getType() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportDay

getWorkingHours() - Method in interface org.itsallcode.whiterabbit.api.model.DayData

getWorkingTime() - Method in interface org.itsallcode.whiterabbit.api.model.ProjectReportActivity

getYear() - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

H

HOLIDAY - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Public holiday (not working)

Holidays - Interface in org.itsallcode.whiterabbit.api.features

PluginFeature that generates a List of Holidays.HolidayInstance for each day.

Holidays.HolidayInstance - Interface in org.itsallcode.whiterabbit.api.features

Represents a holiday instance.

I

init(PluginConfiguration) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

init(PluginConfiguration) - Method in interface org.itsallcode.whiterabbit.api.Plugin

Called once when loading the plugin.

isCanceled() - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor

Call this method repeatedly to check, if the user wants to cancel the process.

isRemainder() - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

isWorkDay() - Method in enum class org.itsallcode.whiterabbit.api.model.DayType

L

load(YearMonth) - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage

loadAll() - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage

M

MonthData - Interface in org.itsallcode.whiterabbit.api.model

Model class for data of a single month containing year, month, day data etc.

MonthDataStorage - Interface in org.itsallcode.whiterabbit.api.features

PluginFeature that provides a storage backend for month data.

MonthDataStorage.ModelFactory - Interface in org.itsallcode.whiterabbit.api.features

A MonthDataStorage.ModelFactory allows creating new instances of the data model.

O

org.itsallcode.whiterabbit.api - package org.itsallcode.whiterabbit.api

org.itsallcode.whiterabbit.api.features - package org.itsallcode.whiterabbit.api.features

org.itsallcode.whiterabbit.api.model - package org.itsallcode.whiterabbit.api.model

P

Plugin - Interface in org.itsallcode.whiterabbit.api

Implement this interface to create a plugin for WhiteRabbit.

PluginConfiguration - Interface in org.itsallcode.whiterabbit.api

The configuration of a Plugin that allows retrieving configuration values from the WhiteRabbit properties file ~/.whiterabbit.properties.

PluginFeature - Interface in org.itsallcode.whiterabbit.api.features

Super interface for all features supported by a Plugin.

ProgressMonitor - Interface in org.itsallcode.whiterabbit.api.features

A progress monitor passed to a PluginFeature that allows reporting the progress of process.

Project - Interface in org.itsallcode.whiterabbit.api.model

The project you work on during an activity containing an ID, label and cost carrier id.

ProjectReport - Interface in org.itsallcode.whiterabbit.api.model

A monthly project report.

ProjectReportActivity - Interface in org.itsallcode.whiterabbit.api.model

An activity during a day where you worked for a specific time duration on a Project.

ProjectReportDay - Interface in org.itsallcode.whiterabbit.api.model

The projects worked on during a single day of the ProjectReport including date and activities.

ProjectReportExporter - Interface in org.itsallcode.whiterabbit.api.features

A PluginFeature that allows exporting a monthly ProjectReport to another system.

S

setActivities(List<ActivityData>) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the ActivityDatas for this day.

setBegin(LocalTime) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the begin time for this day.

setComment(String) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

Set the activity's comment.

setComment(String) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the comment for this day.

setDate(LocalDate) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the date for this day.

setDays(List<DayData>) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

Set the DayDatas in this month.

setDuration(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

Set the duration of the activity.

setEnd(LocalTime) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the end time for this day.

setInterruption(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the duration of the interruption for this day.

setMonth(Month) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

Set a new Month.

setOvertimePreviousMonth(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

Set the duration of the previous month's overtime.

setProjectId(String) - Method in interface org.itsallcode.whiterabbit.api.model.ActivityData

Set the project's ID.

setTaskName(String) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor

setType(DayType) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the DayType for this day.

setWorkingHours(Duration) - Method in interface org.itsallcode.whiterabbit.api.model.DayData

Set the working hours for this day.

setYear(int) - Method in interface org.itsallcode.whiterabbit.api.model.MonthData

Set the year of this month.

SICK - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Sick, paid sick leave (not working)

store(YearMonth, MonthData) - Method in interface org.itsallcode.whiterabbit.api.features.MonthDataStorage

Store the data for a given month.

supports(Class<? extends PluginFeature>) - Method in class org.itsallcode.whiterabbit.api.AbstractPlugin

supports(Class<? extends PluginFeature>) - Method in interface org.itsallcode.whiterabbit.api.Plugin

Check if this plugin supports the given feature.

V

VACATION - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Vacation, paid time off (not working)

valueOf(String) - Static method in enum class org.itsallcode.whiterabbit.api.model.DayType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.itsallcode.whiterabbit.api.model.DayType

Returns an array containing the constants of this enum class, in the order they are declared.

W

WEEKEND - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Weekend (Saturday, Sunday, not working)

WORK - Enum constant in enum class org.itsallcode.whiterabbit.api.model.DayType

Normal working day

worked(int) - Method in interface org.itsallcode.whiterabbit.api.features.ProgressMonitor

Notifies that a given number of work unit of the main task has been completed.

A B C D E F G H I L M O P S V W
All Classes and Interfaces|All Packages