SubstitutionScheduleDay (parser 1.0.0-beta326 API)

java.lang.Object
- me.vertretungsplan.objects.SubstitutionScheduleDay

All Implemented Interfaces:

java.lang.Cloneable
```
public class SubstitutionScheduleDay
extends java.lang.Object
implements java.lang.Cloneable
```
Represents one day on the the SubstitutionSchedule and contains the corresponding substitutions and messages.

Constructor Summary

Constructors
Constructor and Description

SubstitutionScheduleDay()

Constructors
Constructor and Description
`SubstitutionScheduleDay()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllSubstitutions(java.util.Collection<? extends Substitution> substitutions)` Add multiple substitutions for this day
`void`	`addAllSubstitutions(Substitution... substitutions)` Add multiple substitutions for this day
`void`	`addMessage(java.lang.String message)` Add a message for this day.
`void`	`addSubstitution(Substitution substitution)` Add a substitution for this day
`SubstitutionScheduleDay`	`clone()`
`boolean`	`equals(java.lang.Object o)`
`boolean`	`equalsByDate(SubstitutionScheduleDay other)` Check if this day's date is equal to the one of another `SubstitutionScheduleDay`.
`java.lang.String`	`getComment()` Get the comment for this day (displayed next to the date - e.g.
`org.joda.time.LocalDate`	`getDate()` Get the date of this day.
`java.lang.String`	`getDateString()` Get the date of this day, as a string representation
`org.joda.time.LocalDateTime`	`getLastChange()` Get the date and time where this day on the schedule was last updated.
`java.lang.String`	`getLastChangeString()` Get the date and time where this day on the schedule was last updated as a string representation.
`java.util.List<java.lang.String>`	`getMessages()` Get all messages for this day.
`java.util.Set<Substitution>`	`getSubstitutions()` Get all substitutions for this day
`java.util.Set<Substitution>`	`getSubstitutionsByClass(java.lang.String theClass)`
`java.util.Set<Substitution>`	`getSubstitutionsByClassAndExcludedSubject(java.lang.String theClass, java.util.Set<java.lang.String> excludedSubjects)` Get only the substitutions that apply to the given class and that are not for one of the given subjects.
`java.util.Set<Substitution>`	`getSubstitutionsByTeacherAndExcludedSubject(java.lang.String teacher, java.util.Set<java.lang.String> excludedSubjects)` Get only the substitutions that apply to the given teacher and that are not for one of the given subjects.
`int`	`hashCode()`
`void`	`merge(SubstitutionScheduleDay day)` Merge substitutions from this day with those from another `SubstitutionScheduleDay`.
`void`	`setComment(java.lang.String comment)` Set the comment for this day (displayed next to the date - e.g.
`void`	`setDate(org.joda.time.LocalDate date)` Set the date of this day.
`void`	`setDateString(java.lang.String dateString)` Set the date of this day a string representation.
`void`	`setLastChange(org.joda.time.LocalDateTime lastChange)` Set the date and time where this day on the schedule was last updated.
`void`	`setLastChangeString(java.lang.String lastChangeString)` Set the date and time where this day on the schedule was last updated as a string representation.
`void`	`setSubstitutions(java.util.Set<Substitution> substitutions)` Set the substitutions for this day
`java.lang.String`	`toString()`
`java.lang.String`	`toString(SubstitutionSchedule.Type type)` Get a string representation of the day, using different wording depending on the type.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
 - SubstitutionScheduleDay
```
public SubstitutionScheduleDay()
```
- Method Detail
 - getDate
```
public org.joda.time.LocalDate getDate()
```
 Get the date of this day. If the date could not be parsed, there is only a string representation available using getDateString().
 
 Returns:
 
 the date
 - setDate
```
public void setDate(org.joda.time.LocalDate date)
```
 Set the date of this day. If the date could not be parsed, use setDateString(String) to specify a string representation.
 
 Parameters:
 
 date - the date
 - getDateString
```
public java.lang.String getDateString()
```
 Get the date of this day, as a string representation
 
 Returns:
 
 the date of this day, as a string representation
 - setDateString
```
public void setDateString(java.lang.String dateString)
```
 Set the date of this day a string representation. If you used setDate(LocalDate), you do not need to add this.
 
 Parameters:
 
 dateString - the date of this day, as a string representation
 - getLastChange
```
@Nullable
public org.joda.time.LocalDateTime getLastChange()
```
 Get the date and time where this day on the schedule was last updated. If the date could not be parsed, there is only a string representation available using getLastChangeString(). May be null if the last change date is only set for the whole schedule (SubstitutionSchedule.getLastChange()).
 
 Returns:
 
 the date and time where this day was last updated
 - setLastChange
```
public void setLastChange(org.joda.time.LocalDateTime lastChange)
```
 Set the date and time where this day on the schedule was last updated. If the date could not be parsed, use setLastChangeString(String) to specify a string representation. If the last change date is only available for the whole schedule, use SubstitutionSchedule.setLastChange(LocalDateTime)
 
 Parameters:
 
 lastChange - the date and time where this day was last updated.
 - getLastChangeString
```
@Nullable
public java.lang.String getLastChangeString()
```
 Get the date and time where this day on the schedule was last updated as a string representation. May be null if the last change date is only set for the whole schedule (SubstitutionSchedule.getLastChangeString()).
 
 Returns:
 
 the date and time where this day was last updated, as a string representation
 - setLastChangeString
```
public void setLastChangeString(java.lang.String lastChangeString)
```
 Set the date and time where this day on the schedule was last updated as a string representation. If you can parse the date, you should use setLastChange(LocalDateTime) instead. If the last change date is only available for the whole schedule, use SubstitutionSchedule.setLastChangeString(String)
 
 Parameters:
 
 lastChangeString - the date and time where this day was last updated, as a string representation
 - getSubstitutions
```
public java.util.Set<Substitution> getSubstitutions()
```
 Get all substitutions for this day
 
 Returns:
 
 all substitutions for this day
 - setSubstitutions
```
public void setSubstitutions(java.util.Set<Substitution> substitutions)
```
 Set the substitutions for this day
 
 Parameters:
 
 substitutions - the set of substitutions for this day
 - getSubstitutionsByClass
```
public java.util.Set<Substitution> getSubstitutionsByClass(java.lang.String theClass)
```
 - getMessages
```
public java.util.List<java.lang.String> getMessages()
```
 Get all messages for this day. May include simple HTML markup (only a subset of the tags is supported, such as bold and italic.
 
 Returns:
 
 the list of messages for this day
 - addMessage
```
public void addMessage(java.lang.String message)
```
 Add a message for this day. May include simple HTML markup (only a subset of the tags is supported, such as bold and italic.
 
 Parameters:
 
 message - the message to add
 - getComment
```
public java.lang.String getComment()
```
 Get the comment for this day (displayed next to the date - e.g. "A-Woche")
 
 Returns:
 
 the comment for this day
 - setComment
```
public void setComment(java.lang.String comment)
```
 Set the comment for this day (displayed next to the date - e.g. "A-Woche")
 
 Parameters:
 
 comment - the comment for this day
 - addSubstitution
```
public void addSubstitution(Substitution substitution)
```
 Add a substitution for this day
 
 Parameters:
 
 substitution - the substitution to add
 - addAllSubstitutions
```
public void addAllSubstitutions(Substitution... substitutions)
```
 Add multiple substitutions for this day
 
 Parameters:
 
 substitutions - the substitutions to add
 - addAllSubstitutions
```
public void addAllSubstitutions(java.util.Collection<? extends Substitution> substitutions)
```
 Add multiple substitutions for this day
 
 Parameters:
 
 substitutions - the substitutions to add
 - merge
```
public void merge(SubstitutionScheduleDay day)
```
 Merge substitutions from this day with those from another SubstitutionScheduleDay. Both must have the same date.
 
 Parameters:
 
 day - the day to merge with this day
 - equalsByDate
```
public boolean equalsByDate(SubstitutionScheduleDay other)
```
 Check if this day's date is equal to the one of another SubstitutionScheduleDay. Also works if only the string representation is specified (setDateString(String)).
 
 Parameters:
 
 other - the day to compare with this one
 
 Returns:
 
 boolean indicating if the dates are equal
 - getSubstitutionsByClassAndExcludedSubject
```
public java.util.Set<Substitution> getSubstitutionsByClassAndExcludedSubject(java.lang.String theClass,
 java.util.Set<java.lang.String> excludedSubjects)
```
 Get only the substitutions that apply to the given class and that are not for one of the given subjects.
 
 Parameters:
 
 theClass - the class to find substitutions for
 
 excludedSubjects - the subjects to exclude
 
 Returns:
 
 a set of filtered substitutions
 - getSubstitutionsByTeacherAndExcludedSubject
```
public java.util.Set<Substitution> getSubstitutionsByTeacherAndExcludedSubject(java.lang.String teacher,
 java.util.Set<java.lang.String> excludedSubjects)
```
 Get only the substitutions that apply to the given teacher and that are not for one of the given subjects.
 
 Parameters:
 
 teacher - the teacher to find substitutions for
 
 excludedSubjects - the subjects to exclude
 
 Returns:
 
 a set of filtered substitutions
 - clone
```
public SubstitutionScheduleDay clone()
```
 Overrides:
 
 clone in class java.lang.Object
 - toString
```
public java.lang.String toString(SubstitutionSchedule.Type type)
```
 Get a string representation of the day, using different wording depending on the type. Useful for debugging (console output).
 
 Parameters:
 
 type - the type of the SubstitutionSchedule. Affects the format in which the single Substitutions are output
 
 Returns:
 
 a string representation of this day
 - toString
```
public java.lang.String toString()
```
 Overrides:
 
 toString in class java.lang.Object
 - equals
```
public boolean equals(java.lang.Object o)
```
 Overrides:
 
 equals in class java.lang.Object
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class java.lang.Object

Class SubstitutionScheduleDay

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubstitutionScheduleDay

Method Detail

getDate

setDate

getDateString

setDateString

getLastChange

setLastChange

getLastChangeString

setLastChangeString

getSubstitutions

setSubstitutions

getSubstitutionsByClass

getMessages

addMessage

getComment

setComment

addSubstitution

addAllSubstitutions

addAllSubstitutions

merge

equalsByDate

getSubstitutionsByClassAndExcludedSubject

getSubstitutionsByTeacherAndExcludedSubject

clone

toString

toString

equals

hashCode