Skip to content

Commit 924fdd9

Browse files
author
Maxime Suret
committed
update javadoc
1 parent 218a62f commit 924fdd9

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

src/main/java/org/dhatim/businesshours/BusinessPeriod.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public class BusinessPeriod {
3838
private final BusinessTemporal end;
3939

4040
/**
41-
* Builds a new instance of {@link BusinessPeriod}
41+
* Builds a new instance of {@link BusinessPeriod}.
4242
* @param start when the period opens
4343
* @param end when the period closes
4444
*/
@@ -48,7 +48,7 @@ public BusinessPeriod(BusinessTemporal start, BusinessTemporal end) {
4848
}
4949

5050
/**
51-
* Tells if this period is always open
51+
* Tells if this period is always open.
5252
* @return true if the business is always open, false otherwise
5353
*/
5454
public boolean alwaysOpen() {
@@ -75,7 +75,7 @@ public long timeBeforeOpening(Temporal temporal, ChronoUnit unit) {
7575
}
7676

7777
/**
78-
* Get a {@link CronExpression} that triggers at each period opening
78+
* Get a {@link CronExpression} that triggers at each period opening.
7979
* e.g. if the period is 9am-18pm, the result will be <code>0 9 * * *</code>
8080
* @return <code>null</code> if the period is always open, else the cron expression
8181
*/
@@ -84,15 +84,15 @@ public CronExpression getStartCron() {
8484
}
8585

8686
/**
87-
* Get the opening time of this period
87+
* Get the opening time of this period.
8888
* @return when this period opens
8989
*/
9090
public BusinessTemporal getStart() {
9191
return start;
9292
}
9393

9494
/**
95-
* Get the closing time of this period
95+
* Get the closing time of this period.
9696
* @return when this period closes
9797
*/
9898
public BusinessTemporal getEnd() {
@@ -125,7 +125,7 @@ public boolean equals(Object obj) {
125125
}
126126

127127
/**
128-
* Merge intersecting or adjacent periods
128+
* Merge intersecting or adjacent periods.
129129
* @param periods the periods to merge
130130
* @return the merged periods.
131131
* Their opening time spans will be exactly the same as the input periods.

src/main/java/org/dhatim/businesshours/BusinessTemporal.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ private static BusinessTemporal from(TemporalAccessor temporal, Set<ChronoField>
6969
}
7070

7171
/**
72-
* Check that the given fields are contiguous and have a fixed length
72+
* Check that the given fields are contiguous and have a fixed length.
7373
*
7474
* @param supportedFields the fields
7575
*/
@@ -203,7 +203,7 @@ public long until(Temporal endExclusive, TemporalUnit unit) {
203203
}
204204

205205
/**
206-
* Increments the least significant field of this Business Temporal by one
206+
* Increments the least significant field of this Business Temporal by one.
207207
*
208208
* @return a new Business Temporal with the incremented field
209209
*/
@@ -236,8 +236,8 @@ public long since(final Temporal temporal, ChronoUnit unit) {
236236
}
237237

238238
/**
239-
* get all the fields that are measured with a unit greater than or equals
240-
* to the provided unit
239+
* Get all the fields that are measured with a unit greater than or equals
240+
* to the provided unit.
241241
*
242242
* @param unit the unit
243243
* @return a set containing the relevant fields
@@ -287,7 +287,7 @@ public boolean equals(Object obj) {
287287

288288
/**
289289
* Equivalent of Duration.get(unit), but supports units differents than
290-
* SECOND and NANO
290+
* SECOND and NANO.
291291
*
292292
* @param duration the duration
293293
* @param unit the unit
@@ -298,7 +298,7 @@ private static long durationInUnit(Duration duration, TemporalUnit unit) {
298298
}
299299

300300
/**
301-
* Equivalent of Temporal.getLong with arbitrary base and range units
301+
* Equivalent of Temporal.getLong with arbitrary base and range units.
302302
*
303303
* @param temporal the temporal to query
304304
* @param baseUnit the base unit

src/main/java/org/dhatim/businesshours/CronExpression.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ public int hashCode() {
131131

132132
/**
133133
* Tells if this cron expression is equals to the given one.
134-
* Two cron expresions are equals if they trigger at exactly the same moments.
134+
* Two cron expresions are equals if they trigger at exactly the same instants.
135135
* @param obj the object to this expression compare to
136136
* @return true if the expressions are equals, false otherwise
137137
*/
@@ -145,7 +145,7 @@ public boolean equals(Object obj) {
145145
}
146146

147147
/**
148-
* Convert this cron expression into its string representation
148+
* Convert this cron expression into its string representation.
149149
*
150150
* @see <a href="https://en.wikipedia.org/wiki/Cron#CRON_expression">the
151151
* cron expression format</a>
@@ -193,7 +193,7 @@ private static String rangeToString(ValueRange range) {
193193
/**
194194
* Merge the given cron expressions where it is possible.
195195
* For instance, <code>"2 18 * * *"</code> and <code>"4 18 * * *"</code>
196-
* can be merged in <code>"2,4 18 * * *"</code>
196+
* can be merged in <code>"2,4 18 * * *"</code>.
197197
* @param crons the cron expressions to merge
198198
* @return the merged cron expressions.
199199
* They will trigger at the exact same moments as the input cron expressions.

0 commit comments

Comments
 (0)