Skip to content

Commit a5f149e

Browse files
lutovichlutovich
committed
Renamed custom Duration to IsoDuration
So it does not clash with `java.time.Duration` and specifies that it's a combination of date-based amount and time-based amount.
1 parent 3e58227 commit a5f149e

File tree

13 files changed

+78
-78
lines changed

13 files changed

+78
-78
lines changed

‎driver/src/main/java/org/neo4j/driver/internal/InternalDuration.java renamed to ‎driver/src/main/java/org/neo4j/driver/internal/InternalIsoDuration.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import java.util.List;
2525
import java.util.Objects;
2626

27-
import org.neo4j.driver.v1.types.Duration;
27+
import org.neo4j.driver.v1.types.IsoDuration;
2828

2929
import static java.time.temporal.ChronoUnit.DAYS;
3030
import static java.time.temporal.ChronoUnit.MONTHS;
@@ -33,7 +33,7 @@
3333
import static java.util.Arrays.asList;
3434
import static java.util.Collections.unmodifiableList;
3535

36-
public class InternalDuration implements Duration
36+
public class InternalIsoDuration implements IsoDuration
3737
{
3838
private static final List<TemporalUnit> SUPPORTED_UNITS = unmodifiableList( asList( MONTHS, DAYS, SECONDS, NANOS ) );
3939

@@ -42,7 +42,7 @@ public class InternalDuration implements Duration
4242
private final long seconds;
4343
private final long nanoseconds;
4444

45-
public InternalDuration( long months, long days, long seconds, long nanoseconds )
45+
public InternalIsoDuration( long months, long days, long seconds, long nanoseconds )
4646
{
4747
this.months = months;
4848
this.days = days;
@@ -160,7 +160,7 @@ public boolean equals( Object o )
160160
{
161161
return false;
162162
}
163-
InternalDuration that = (InternalDuration) o;
163+
InternalIsoDuration that = (InternalIsoDuration) o;
164164
return months == that.months &&
165165
days == that.days &&
166166
seconds == that.seconds &&

‎driver/src/main/java/org/neo4j/driver/internal/messaging/PackStreamMessageFormatV2.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@
3333
import org.neo4j.driver.internal.types.TypeConstructor;
3434
import org.neo4j.driver.internal.value.InternalValue;
3535
import org.neo4j.driver.v1.Value;
36-
import org.neo4j.driver.v1.types.Duration;
36+
import org.neo4j.driver.v1.types.IsoDuration;
3737
import org.neo4j.driver.v1.types.Point2D;
3838
import org.neo4j.driver.v1.types.Point3D;
3939

4040
import static java.time.ZoneOffset.UTC;
41-
import static org.neo4j.driver.v1.Values.duration;
41+
import static org.neo4j.driver.v1.Values.isoDuration;
4242
import static org.neo4j.driver.v1.Values.point2D;
4343
import static org.neo4j.driver.v1.Values.point3D;
4444
import static org.neo4j.driver.v1.Values.value;
@@ -115,7 +115,7 @@ void packInternalValue( InternalValue value ) throws IOException
115115
packZonedDateTime( value.asZonedDateTime() );
116116
break;
117117
case DURATION:
118-
packDuration( value.asDuration() );
118+
packDuration( value.asIsoDuration() );
119119
break;
120120
case POINT_2D:
121121
packPoint2D( value.asPoint2D() );
@@ -186,7 +186,7 @@ private void packZonedDateTime( ZonedDateTime zonedDateTime ) throws IOException
186186
}
187187
}
188188

189-
private void packDuration( Duration duration ) throws IOException
189+
private void packDuration( IsoDuration duration ) throws IOException
190190
{
191191
packer.packStructHeader( DURATION_TIME_STRUCT_SIZE, DURATION );
192192
packer.pack( duration.months() );
@@ -314,7 +314,7 @@ private Value unpackDuration() throws IOException
314314
long days = unpacker.unpackLong();
315315
long seconds = unpacker.unpackLong();
316316
long nanoseconds = unpacker.unpackLong();
317-
return duration( months, days, seconds, nanoseconds );
317+
return isoDuration( months, days, seconds, nanoseconds );
318318
}
319319

320320
private Value unpackPoint2D() throws IOException

‎driver/src/main/java/org/neo4j/driver/internal/value/DurationValue.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@
1919
package org.neo4j.driver.internal.value;
2020

2121
import org.neo4j.driver.internal.types.InternalTypeSystem;
22-
import org.neo4j.driver.v1.types.Duration;
22+
import org.neo4j.driver.v1.types.IsoDuration;
2323
import org.neo4j.driver.v1.types.Type;
2424

25-
public class DurationValue extends ObjectValueAdapter<Duration>
25+
public class DurationValue extends ObjectValueAdapter<IsoDuration>
2626
{
27-
public DurationValue( Duration duration )
27+
public DurationValue( IsoDuration duration )
2828
{
2929
super( duration );
3030
}
3131

3232
@Override
33-
public Duration asDuration()
33+
public IsoDuration asIsoDuration()
3434
{
3535
return asObject();
3636
}

‎driver/src/main/java/org/neo4j/driver/internal/value/ValueAdapter.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
import org.neo4j.driver.v1.exceptions.value.NotMultiValued;
3434
import org.neo4j.driver.v1.exceptions.value.Uncoercible;
3535
import org.neo4j.driver.v1.exceptions.value.Unsizable;
36-
import org.neo4j.driver.v1.types.Duration;
3736
import org.neo4j.driver.v1.types.Entity;
37+
import org.neo4j.driver.v1.types.IsoDuration;
3838
import org.neo4j.driver.v1.types.Node;
3939
import org.neo4j.driver.v1.types.Path;
4040
import org.neo4j.driver.v1.types.Point2D;
@@ -218,7 +218,7 @@ public ZonedDateTime asZonedDateTime()
218218
}
219219

220220
@Override
221-
public Duration asDuration()
221+
public IsoDuration asIsoDuration()
222222
{
223223
throw new Uncoercible( type().name(), "Duration" );
224224
}

‎driver/src/main/java/org/neo4j/driver/v1/Value.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
import org.neo4j.driver.v1.exceptions.ClientException;
3030
import org.neo4j.driver.v1.exceptions.value.LossyCoercion;
3131
import org.neo4j.driver.v1.exceptions.value.Uncoercible;
32-
import org.neo4j.driver.v1.types.Duration;
3332
import org.neo4j.driver.v1.types.Entity;
33+
import org.neo4j.driver.v1.types.IsoDuration;
3434
import org.neo4j.driver.v1.types.MapAccessor;
3535
import org.neo4j.driver.v1.types.MapAccessorWithDefaultValue;
3636
import org.neo4j.driver.v1.types.Node;
@@ -328,10 +328,10 @@ public interface Value extends MapAccessor, MapAccessorWithDefaultValue
328328
ZonedDateTime asZonedDateTime();
329329

330330
/**
331-
* @return the value as a {@link Duration}, if possible.
331+
* @return the value as a {@link IsoDuration}, if possible.
332332
* @throws Uncoercible if value types are incompatible.
333333
*/
334-
Duration asDuration();
334+
IsoDuration asIsoDuration();
335335

336336
/**
337337
* @return the value as a {@link Point2D}, if possible.

‎driver/src/main/java/org/neo4j/driver/v1/Values.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
import java.util.Map;
3434

3535
import org.neo4j.driver.internal.AsValue;
36-
import org.neo4j.driver.internal.InternalDuration;
36+
import org.neo4j.driver.internal.InternalIsoDuration;
3737
import org.neo4j.driver.internal.InternalPoint2D;
3838
import org.neo4j.driver.internal.InternalPoint3D;
3939
import org.neo4j.driver.internal.value.BooleanValue;
@@ -53,8 +53,8 @@
5353
import org.neo4j.driver.internal.value.StringValue;
5454
import org.neo4j.driver.internal.value.TimeValue;
5555
import org.neo4j.driver.v1.exceptions.ClientException;
56-
import org.neo4j.driver.v1.types.Duration;
5756
import org.neo4j.driver.v1.types.Entity;
57+
import org.neo4j.driver.v1.types.IsoDuration;
5858
import org.neo4j.driver.v1.types.MapAccessor;
5959
import org.neo4j.driver.v1.types.Node;
6060
import org.neo4j.driver.v1.types.Path;
@@ -106,7 +106,7 @@ public static Value value( Object value )
106106
if ( value instanceof LocalTime ) { return value( (LocalTime) value ); }
107107
if ( value instanceof LocalDateTime ) { return value( (LocalDateTime) value ); }
108108
if ( value instanceof ZonedDateTime ) { return value( (ZonedDateTime) value ); }
109-
if ( value instanceof Duration ) { return value( (Duration) value ); }
109+
if ( value instanceof IsoDuration ) { return value( (IsoDuration) value ); }
110110
if ( value instanceof Point2D ) { return value( (Point2D) value ); }
111111
if ( value instanceof Point3D ) { return value( (Point3D) value ); }
112112

@@ -312,12 +312,12 @@ public static Value value( ZonedDateTime zonedDateTime )
312312
return new DateTimeValue( zonedDateTime );
313313
}
314314

315-
public static Value duration( long months, long days, long seconds, long nanoseconds )
315+
public static Value isoDuration( long months, long days, long seconds, long nanoseconds )
316316
{
317-
return value( new InternalDuration( months, days, seconds, nanoseconds ) );
317+
return value( new InternalIsoDuration( months, days, seconds, nanoseconds ) );
318318
}
319319

320-
private static Value value( Duration duration )
320+
private static Value value( IsoDuration duration )
321321
{
322322
return new DurationValue( duration );
323323
}
@@ -617,13 +617,13 @@ public static Function<Value,ZonedDateTime> ofZonedDateTime()
617617
}
618618

619619
/**
620-
* Converts values to {@link Duration}.
620+
* Converts values to {@link IsoDuration}.
621621
*
622-
* @return a function that returns {@link Value#asDuration()} of a {@link Value}
622+
* @return a function that returns {@link Value#asIsoDuration()} of a {@link Value}
623623
*/
624-
public static Function<Value,Duration> ofDuration()
624+
public static Function<Value,IsoDuration> ofIsoDuration()
625625
{
626-
return Value::asDuration;
626+
return Value::asIsoDuration;
627627
}
628628

629629
/**

‎driver/src/main/java/org/neo4j/driver/v1/types/Duration.java renamed to ‎driver/src/main/java/org/neo4j/driver/v1/types/IsoDuration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
import org.neo4j.driver.v1.util.Immutable;
2525

2626
/**
27-
* Represents temporal amount containing months, days, seconds and nanoseconds of the second. A duration¬ can be negative.
27+
* Represents temporal amount containing months, days, seconds and nanoseconds of the second. A duration can be negative.
2828
* <p>
29-
* Value that represents a duration can be created using {@link Values#duration(long, long, long, long)} method.
29+
* Value that represents a duration can be created using {@link Values#isoDuration(long, long, long, long)} method.
3030
*/
3131
@Immutable
32-
public interface Duration extends TemporalAmount
32+
public interface IsoDuration extends TemporalAmount
3333
{
3434
/**
3535
* Retrieve amount of months in this duration.

‎driver/src/test/java/org/neo4j/driver/internal/InternalDurationTest.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
import java.time.temporal.Temporal;
2525
import java.time.temporal.UnsupportedTemporalTypeException;
2626

27-
import org.neo4j.driver.v1.types.Duration;
27+
import org.neo4j.driver.v1.types.IsoDuration;
2828

2929
import static java.time.temporal.ChronoUnit.DAYS;
3030
import static java.time.temporal.ChronoUnit.MONTHS;
@@ -40,39 +40,39 @@ public class InternalDurationTest
4040
@Test
4141
public void shouldExposeMonths()
4242
{
43-
Duration duration = newDuration( 42, 1, 2, 3 );
43+
IsoDuration duration = newDuration( 42, 1, 2, 3 );
4444
assertEquals( 42, duration.months() );
4545
assertEquals( 42, duration.get( MONTHS ) );
4646
}
4747

4848
@Test
4949
public void shouldExposeDays()
5050
{
51-
Duration duration = newDuration( 1, 42, 2, 3 );
51+
IsoDuration duration = newDuration( 1, 42, 2, 3 );
5252
assertEquals( 42, duration.days() );
5353
assertEquals( 42, duration.get( DAYS ) );
5454
}
5555

5656
@Test
5757
public void shouldExposeSeconds()
5858
{
59-
Duration duration = newDuration( 1, 2, 42, 3 );
59+
IsoDuration duration = newDuration( 1, 2, 42, 3 );
6060
assertEquals( 42, duration.seconds() );
6161
assertEquals( 42, duration.get( SECONDS ) );
6262
}
6363

6464
@Test
6565
public void shouldExposeNanoseconds()
6666
{
67-
Duration duration = newDuration( 1, 2, 3, 42 );
67+
IsoDuration duration = newDuration( 1, 2, 3, 42 );
6868
assertEquals( 42, duration.nanoseconds() );
6969
assertEquals( 42, duration.get( NANOS ) );
7070
}
7171

7272
@Test
7373
public void shouldFailToGetUnsupportedTemporalUnit()
7474
{
75-
Duration duration = newDuration( 1, 2, 3, 4 );
75+
IsoDuration duration = newDuration( 1, 2, 3, 4 );
7676

7777
try
7878
{
@@ -87,14 +87,14 @@ public void shouldFailToGetUnsupportedTemporalUnit()
8787
@Test
8888
public void shouldExposeSupportedTemporalUnits()
8989
{
90-
Duration duration = newDuration( 1, 2, 3, 4 );
90+
IsoDuration duration = newDuration( 1, 2, 3, 4 );
9191
assertEquals( asList( MONTHS, DAYS, SECONDS, NANOS ), duration.getUnits() );
9292
}
9393

9494
@Test
9595
public void shouldAddTo()
9696
{
97-
Duration duration = newDuration( 1, 2, 3, 4 );
97+
IsoDuration duration = newDuration( 1, 2, 3, 4 );
9898
LocalDateTime dateTime = LocalDateTime.of( 1990, 1, 1, 0, 0, 0, 0 );
9999

100100
Temporal result = duration.addTo( dateTime );
@@ -105,7 +105,7 @@ public void shouldAddTo()
105105
@Test
106106
public void shouldSubtractFrom()
107107
{
108-
Duration duration = newDuration( 4, 3, 2, 1 );
108+
IsoDuration duration = newDuration( 4, 3, 2, 1 );
109109
LocalDateTime dateTime = LocalDateTime.of( 1990, 7, 19, 0, 0, 59, 999 );
110110

111111
Temporal result = duration.subtractFrom( dateTime );
@@ -116,15 +116,15 @@ public void shouldSubtractFrom()
116116
@Test
117117
public void shouldImplementEqualsAndHashCode()
118118
{
119-
Duration duration1 = newDuration( 1, 2, 3, 4 );
120-
Duration duration2 = newDuration( 1, 2, 3, 4 );
119+
IsoDuration duration1 = newDuration( 1, 2, 3, 4 );
120+
IsoDuration duration2 = newDuration( 1, 2, 3, 4 );
121121

122122
assertEquals( duration1, duration2 );
123123
assertEquals( duration1.hashCode(), duration2.hashCode() );
124124
}
125125

126-
private static Duration newDuration( long months, long days, long seconds, long nanoseconds )
126+
private static IsoDuration newDuration( long months, long days, long seconds, long nanoseconds )
127127
{
128-
return new InternalDuration( months, days, seconds, nanoseconds );
128+
return new InternalIsoDuration( months, days, seconds, nanoseconds );
129129
}
130130
}

‎driver/src/test/java/org/neo4j/driver/internal/ValuesTest.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
import org.neo4j.driver.v1.Value;
4949
import org.neo4j.driver.v1.Values;
5050
import org.neo4j.driver.v1.exceptions.ClientException;
51-
import org.neo4j.driver.v1.types.Duration;
51+
import org.neo4j.driver.v1.types.IsoDuration;
5252
import org.neo4j.driver.v1.types.Point2D;
5353
import org.neo4j.driver.v1.types.Point3D;
5454

@@ -59,7 +59,7 @@
5959
import static org.junit.Assert.assertEquals;
6060
import static org.junit.Assert.assertNotEquals;
6161
import static org.junit.Assert.assertThat;
62-
import static org.neo4j.driver.v1.Values.duration;
62+
import static org.neo4j.driver.v1.Values.isoDuration;
6363
import static org.neo4j.driver.v1.Values.ofDouble;
6464
import static org.neo4j.driver.v1.Values.ofFloat;
6565
import static org.neo4j.driver.v1.Values.ofInteger;
@@ -409,10 +409,10 @@ public void shouldCreateDateTimeValue()
409409
@Test
410410
public void shouldCreateDurationValue()
411411
{
412-
Value value = duration( 42_1, 42_2, 42_3, 42_4 );
412+
Value value = isoDuration( 42_1, 42_2, 42_3, 42_4 );
413413

414414
assertThat( value, instanceOf( DurationValue.class ) );
415-
Duration duration = value.asDuration();
415+
IsoDuration duration = value.asIsoDuration();
416416

417417
assertEquals( 42_1, duration.months() );
418418
assertEquals( 42_2, duration.days() );
@@ -423,12 +423,12 @@ public void shouldCreateDurationValue()
423423
@Test
424424
public void shouldCreateValueFromDuration()
425425
{
426-
Value durationValue1 = duration( 1, 2, 3, 4 );
427-
Duration duration = durationValue1.asDuration();
426+
Value durationValue1 = isoDuration( 1, 2, 3, 4 );
427+
IsoDuration duration = durationValue1.asIsoDuration();
428428
Value durationValue2 = value( duration );
429429

430-
assertEquals( duration, durationValue1.asDuration() );
431-
assertEquals( duration, durationValue2.asDuration() );
430+
assertEquals( duration, durationValue1.asIsoDuration() );
431+
assertEquals( duration, durationValue2.asIsoDuration() );
432432
assertEquals( durationValue1, durationValue2 );
433433
}
434434

‎driver/src/test/java/org/neo4j/driver/internal/messaging/PackStreamMessageFormatV2Test.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
import org.neo4j.driver.internal.util.ThrowingConsumer;
4343
import org.neo4j.driver.v1.Value;
4444
import org.neo4j.driver.v1.Values;
45-
import org.neo4j.driver.v1.types.Duration;
45+
import org.neo4j.driver.v1.types.IsoDuration;
4646

4747
import static java.time.Month.APRIL;
4848
import static java.time.Month.AUGUST;
@@ -348,8 +348,8 @@ public void shouldReadZonedDateTimeWithZoneId() throws Exception
348348
@Test
349349
public void shouldWriteDuration() throws Exception
350350
{
351-
Value durationValue = Values.duration( Long.MAX_VALUE - 1, Integer.MAX_VALUE - 1, Short.MAX_VALUE - 1, Byte.MAX_VALUE - 1 );
352-
Duration duration = durationValue.asDuration();
351+
Value durationValue = Values.isoDuration( Long.MAX_VALUE - 1, Integer.MAX_VALUE - 1, Short.MAX_VALUE - 1, Byte.MAX_VALUE - 1 );
352+
IsoDuration duration = durationValue.asIsoDuration();
353353

354354
ByteBuf buf = Unpooled.buffer();
355355
MessageFormat.Writer writer = newWriter( buf );
@@ -366,8 +366,8 @@ public void shouldWriteDuration() throws Exception
366366
@Test
367367
public void shouldReadDuration() throws Exception
368368
{
369-
Value durationValue = Values.duration( 17, 22, 99, 15 );
370-
Duration duration = durationValue.asDuration();
369+
Value durationValue = Values.isoDuration( 17, 22, 99, 15 );
370+
IsoDuration duration = durationValue.asIsoDuration();
371371

372372
Object unpacked = packAndUnpackValue( packer ->
373373
{

0 commit comments

Comments
 (0)