GitHub-Spring
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polish capitalisation of units on DataSize and javadoc of DataUnit 

Issue: SPR-17240
pull/1949/head
Stephane Nicoll 8 years ago
parent
454cd933d4
commit
2c1dca5b5e
3 changed files with 77 additions and 77 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 40
      spring-core/src/main/java/org/springframework/util/unit/DataSize.java
  2. 16
      spring-core/src/main/java/org/springframework/util/unit/DataUnit.java
  3. 98
      spring-core/src/test/java/org/springframework/util/unit/DataSizeTests.java

40
spring-core/src/main/java/org/springframework/util/unit/DataSize.java
Unescape View File

@ -39,22 +39,22 @@ public final class DataSize implements Comparable<DataSize> {
private static final Pattern PATTERN = Pattern.compile("^([+\\-]?\\d+)([a-zA-Z]{0,2})$"); private static final Pattern PATTERN = Pattern.compile("^([+\\-]?\\d+)([a-zA-Z]{0,2})$");
/** /**
* Bytes per KiloByte. * Bytes per Kilobyte.
*/ */
private static long BYTES_PER_KB = 1024; private static long BYTES_PER_KB = 1024;
/** /**
* Bytes per MegaByte. * Bytes per Megabyte.
*/ */
private static long BYTES_PER_MB = BYTES_PER_KB * 1024; private static long BYTES_PER_MB = BYTES_PER_KB * 1024;
/** /**
* Bytes per GigaByte. * Bytes per Gigabyte.
*/ */
private static long BYTES_PER_GB = BYTES_PER_MB * 1024; private static long BYTES_PER_GB = BYTES_PER_MB * 1024;
/** /**
* Bytes per TeraByte. * Bytes per Terabyte.
*/ */
private static long BYTES_PER_TB = BYTES_PER_GB * 1024; private static long BYTES_PER_TB = BYTES_PER_GB * 1024;
@ -78,38 +78,38 @@ public final class DataSize implements Comparable<DataSize> {
/** /**
* Obtain a {@link DataSize} representing the specified number of kilobytes. * Obtain a {@link DataSize} representing the specified number of kilobytes.
* @param kiloBytes the number of kilobytes, positive or negative * @param kilobytes the number of kilobytes, positive or negative
* @return a {@link DataSize} * @return a {@link DataSize}
*/ */
public static DataSize ofKiloBytes(long kiloBytes) { public static DataSize ofKilobytes(long kilobytes) {
return new DataSize(Math.multiplyExact(kiloBytes, BYTES_PER_KB)); return new DataSize(Math.multiplyExact(kilobytes, BYTES_PER_KB));
} }
/** /**
* Obtain a {@link DataSize} representing the specified number of megabytes. * Obtain a {@link DataSize} representing the specified number of megabytes.
* @param megaBytes the number of megabytes, positive or negative * @param megabytes the number of megabytes, positive or negative
* @return a {@link DataSize} * @return a {@link DataSize}
*/ */
public static DataSize ofMegaBytes(long megaBytes) { public static DataSize ofMegabytes(long megabytes) {
return new DataSize(Math.multiplyExact(megaBytes, BYTES_PER_MB)); return new DataSize(Math.multiplyExact(megabytes, BYTES_PER_MB));
} }
/** /**
* Obtain a {@link DataSize} representing the specified number of gigabytes. * Obtain a {@link DataSize} representing the specified number of gigabytes.
* @param gigaBytes the number of gigabytes, positive or negative * @param gigabytes the number of gigabytes, positive or negative
* @return a {@link DataSize} * @return a {@link DataSize}
*/ */
public static DataSize ofGigaBytes(long gigaBytes) { public static DataSize ofGigabytes(long gigabytes) {
return new DataSize(Math.multiplyExact(gigaBytes, BYTES_PER_GB)); return new DataSize(Math.multiplyExact(gigabytes, BYTES_PER_GB));
} }
/** /**
* Obtain a {@link DataSize} representing the specified number of terabytes. * Obtain a {@link DataSize} representing the specified number of terabytes.
* @param teraBytes the number of terabytes, positive or negative * @param terabytes the number of terabytes, positive or negative
* @return a {@link DataSize} * @return a {@link DataSize}
*/ */
public static DataSize ofTeraBytes(long teraBytes) { public static DataSize ofTerabytes(long terabytes) {
return new DataSize(Math.multiplyExact(teraBytes, BYTES_PER_TB)); return new DataSize(Math.multiplyExact(terabytes, BYTES_PER_TB));
} }
/** /**
@ -196,7 +196,7 @@ public final class DataSize implements Comparable<DataSize> {
* Return the number of kilobytes in this instance. * Return the number of kilobytes in this instance.
* @return the number of kilobytes * @return the number of kilobytes
*/ */
public long toKiloBytes() { public long toKilobytes() {
return this.bytes / BYTES_PER_KB; return this.bytes / BYTES_PER_KB;
} }
@ -204,7 +204,7 @@ public final class DataSize implements Comparable<DataSize> {
* Return the number of megabytes in this instance. * Return the number of megabytes in this instance.
* @return the number of megabytes * @return the number of megabytes
*/ */
public long toMegaBytes() { public long toMegabytes() {
return this.bytes / BYTES_PER_MB; return this.bytes / BYTES_PER_MB;
} }
@ -212,7 +212,7 @@ public final class DataSize implements Comparable<DataSize> {
* Return the number of gigabytes in this instance. * Return the number of gigabytes in this instance.
* @return the number of gigabytes * @return the number of gigabytes
*/ */
public long toGigaBytes() { public long toGigabytes() {
return this.bytes / BYTES_PER_GB; return this.bytes / BYTES_PER_GB;
} }
@ -220,7 +220,7 @@ public final class DataSize implements Comparable<DataSize> {
* Return the number of terabytes in this instance. * Return the number of terabytes in this instance.
* @return the number of terabytes * @return the number of terabytes
*/ */
public long toTeraBytes() { public long toTerabytes() {
return this.bytes / BYTES_PER_TB; return this.bytes / BYTES_PER_TB;
} }

16
spring-core/src/main/java/org/springframework/util/unit/DataUnit.java
Unescape View File

@ -32,24 +32,24 @@ public enum DataUnit {
BYTES("B", DataSize.ofBytes(1)), BYTES("B", DataSize.ofBytes(1)),
/** /**
* KiloBytes. * Kilobytes.
*/ */
KILOBYTES("KB", DataSize.ofKiloBytes(1)), KILOBYTES("KB", DataSize.ofKilobytes(1)),
/** /**
* MegaBytes. * Megabytes.
*/ */
MEGABYTES("MB", DataSize.ofMegaBytes(1)), MEGABYTES("MB", DataSize.ofMegabytes(1)),
/** /**
* GigaBytes. * Gigabytes.
*/ */
GIGABYTES("GB", DataSize.ofGigaBytes(1)), GIGABYTES("GB", DataSize.ofGigabytes(1)),
/** /**
* TeraBytes. * Terabytes.
*/ */
TERABYTES("TB", DataSize.ofTeraBytes(1)); TERABYTES("TB", DataSize.ofTerabytes(1));
private final String suffix; private final String suffix;

98
spring-core/src/test/java/org/springframework/util/unit/DataSizeTests.java
Unescape View File

@ -38,43 +38,43 @@ public class DataSizeTests {
} }
@Test @Test
public void ofBytesToKiloBytes() { public void ofBytesToKilobytes() {
assertEquals(1, DataSize.ofBytes(1024).toKiloBytes()); assertEquals(1, DataSize.ofBytes(1024).toKilobytes());
} }
@Test @Test
public void ofKiloBytesToKiloBytes() { public void ofKilobytesToKiloBbtes() {
assertEquals(1024, DataSize.ofKiloBytes(1024).toKiloBytes()); assertEquals(1024, DataSize.ofKilobytes(1024).toKilobytes());
} }
@Test @Test
public void ofKiloBytesToMegaBytes() { public void ofKilobytesToMegabytes() {
assertEquals(1, DataSize.ofKiloBytes(1024).toMegaBytes()); assertEquals(1, DataSize.ofKilobytes(1024).toMegabytes());
} }
@Test @Test
public void ofMegaBytesToMegaBytes() { public void ofMegabytesToMegabytes() {
assertEquals(1024, DataSize.ofMegaBytes(1024).toMegaBytes()); assertEquals(1024, DataSize.ofMegabytes(1024).toMegabytes());
} }
@Test @Test
public void ofMegaBytesToGigaBytes() { public void ofMegabytesToGigabytes() {
assertEquals(2, DataSize.ofMegaBytes(2048).toGigaBytes()); assertEquals(2, DataSize.ofMegabytes(2048).toGigabytes());
} }
@Test @Test
public void ofGigaBytesToGigaBytes() { public void ofGigabytesToGigabytes() {
assertEquals(4096, DataSize.ofGigaBytes(4096).toGigaBytes()); assertEquals(4096, DataSize.ofGigabytes(4096).toGigabytes());
} }
@Test @Test
public void ofGigaBytesToTeraBytes() { public void ofGigabytesToTerabytes() {
assertEquals(4, DataSize.ofGigaBytes(4096).toTeraBytes()); assertEquals(4, DataSize.ofGigabytes(4096).toTerabytes());
} }
@Test @Test
public void ofTeraBytesToGigaBytes() { public void ofTerabytesToGigabytes() {
assertEquals(1024, DataSize.ofTeraBytes(1).toGigaBytes()); assertEquals(1024, DataSize.ofTerabytes(1).toGigabytes());
} }
@Test @Test
@ -83,28 +83,28 @@ public class DataSizeTests {
} }
@Test @Test
public void ofWithKiloBytesUnit() { public void ofWithKilobytesUnit() {
assertEquals(DataSize.ofKiloBytes(20), DataSize.of(20, DataUnit.KILOBYTES)); assertEquals(DataSize.ofKilobytes(20), DataSize.of(20, DataUnit.KILOBYTES));
} }
@Test @Test
public void ofWithMegaBytesUnit() { public void ofWithMegabytesUnit() {
assertEquals(DataSize.ofMegaBytes(30), DataSize.of(30, DataUnit.MEGABYTES)); assertEquals(DataSize.ofMegabytes(30), DataSize.of(30, DataUnit.MEGABYTES));
} }
@Test @Test
public void ofWithGigaBytesUnit() { public void ofWithGigabytesUnit() {
assertEquals(DataSize.ofGigaBytes(40), DataSize.of(40, DataUnit.GIGABYTES)); assertEquals(DataSize.ofGigabytes(40), DataSize.of(40, DataUnit.GIGABYTES));
} }
@Test @Test
public void ofWithTeraBytesUnit() { public void ofWithTerabytesUnit() {
assertEquals(DataSize.ofTeraBytes(50), DataSize.of(50, DataUnit.TERABYTES)); assertEquals(DataSize.ofTerabytes(50), DataSize.of(50, DataUnit.TERABYTES));
} }
@Test @Test
public void parseWithDefaultUnitUsesBytes() { public void parseWithDefaultUnitUsesBytes() {
assertEquals(DataSize.ofKiloBytes(1), DataSize.parse("1024")); assertEquals(DataSize.ofKilobytes(1), DataSize.parse("1024"));
} }
@Test @Test
@ -114,77 +114,77 @@ public class DataSizeTests {
@Test @Test
public void parseWithNullDefaultUnitUsesBytes() { public void parseWithNullDefaultUnitUsesBytes() {
assertEquals(DataSize.ofKiloBytes(1), DataSize.parse("1024", null)); assertEquals(DataSize.ofKilobytes(1), DataSize.parse("1024", null));
} }
@Test @Test
public void parseNegativeNumberWithNullDefaultUnitUsesBytes() { public void parseNegativeNumberWithNullDefaultUnitUsesBytes() {
assertEquals(DataSize.ofKiloBytes(-1), DataSize.parse("-1024", null)); assertEquals(DataSize.ofKilobytes(-1), DataSize.parse("-1024", null));
} }
@Test @Test
public void parseWithCustomDefaultUnit() { public void parseWithCustomDefaultUnit() {
assertEquals(DataSize.ofKiloBytes(1), DataSize.parse("1", DataUnit.KILOBYTES)); assertEquals(DataSize.ofKilobytes(1), DataSize.parse("1", DataUnit.KILOBYTES));
} }
@Test @Test
public void parseNegativeNumberWithCustomDefaultUnit() { public void parseNegativeNumberWithCustomDefaultUnit() {
assertEquals(DataSize.ofKiloBytes(-1), DataSize.parse("-1", DataUnit.KILOBYTES)); assertEquals(DataSize.ofKilobytes(-1), DataSize.parse("-1", DataUnit.KILOBYTES));
} }
@Test @Test
public void parseWithBytes() { public void parseWithBytes() {
assertEquals(DataSize.ofKiloBytes(1), DataSize.parse("1024B")); assertEquals(DataSize.ofKilobytes(1), DataSize.parse("1024B"));
} }
@Test @Test
public void parseWithNegativeBytes() { public void parseWithNegativeBytes() {
assertEquals(DataSize.ofKiloBytes(-1), DataSize.parse("-1024B")); assertEquals(DataSize.ofKilobytes(-1), DataSize.parse("-1024B"));
} }
@Test @Test
public void parseWithPostivieBytes() { public void parseWithPositiveBytes() {
assertEquals(DataSize.ofKiloBytes(1), DataSize.parse("+1024B")); assertEquals(DataSize.ofKilobytes(1), DataSize.parse("+1024B"));
} }
@Test @Test
public void parseWithKiloBytes() { public void parseWithKilobytes() {
assertEquals(DataSize.ofBytes(1024), DataSize.parse("1KB")); assertEquals(DataSize.ofBytes(1024), DataSize.parse("1KB"));
} }
@Test @Test
public void parseWithNegativeKiloBytes() { public void parseWithNegativeKilobytes() {
assertEquals(DataSize.ofBytes(-1024), DataSize.parse("-1KB")); assertEquals(DataSize.ofBytes(-1024), DataSize.parse("-1KB"));
} }
@Test @Test
public void parseWithMegaBytes() { public void parseWithMegabytes() {
assertEquals(DataSize.ofMegaBytes(4), DataSize.parse("4MB")); assertEquals(DataSize.ofMegabytes(4), DataSize.parse("4MB"));
} }
@Test @Test
public void parseWithNegativeMegaBytes() { public void parseWithNegativeMegabytes() {
assertEquals(DataSize.ofMegaBytes(-4), DataSize.parse("-4MB")); assertEquals(DataSize.ofMegabytes(-4), DataSize.parse("-4MB"));
} }
@Test @Test
public void parseWithGigaBytes() { public void parseWithGigabytes() {
assertEquals(DataSize.ofMegaBytes(1024), DataSize.parse("1GB")); assertEquals(DataSize.ofMegabytes(1024), DataSize.parse("1GB"));
} }
@Test @Test
public void parseWithNegativeGigaBytes() { public void parseWithNegativeGigabytes() {
assertEquals(DataSize.ofMegaBytes(-1024), DataSize.parse("-1GB")); assertEquals(DataSize.ofMegabytes(-1024), DataSize.parse("-1GB"));
} }
@Test @Test
public void parseWithTeraBytes() { public void parseWithTerabytes() {
assertEquals(DataSize.ofTeraBytes(1), DataSize.parse("1TB")); assertEquals(DataSize.ofTerabytes(1), DataSize.parse("1TB"));
} }
@Test @Test
public void parseWithNegativeTeraBytes() { public void parseWithNegativeTerabytes() {
assertEquals(DataSize.ofTeraBytes(-1), DataSize.parse("-1TB")); assertEquals(DataSize.ofTerabytes(-1), DataSize.parse("-1TB"));
} }
@Test @Test
@ -204,12 +204,12 @@ public class DataSizeTests {
@Test @Test
public void toStringUsesBytes() { public void toStringUsesBytes() {
assertEquals("1024B", DataSize.ofKiloBytes(1).toString()); assertEquals("1024B", DataSize.ofKilobytes(1).toString());
} }
@Test @Test
public void toStringWithNegativeBytes() { public void toStringWithNegativeBytes() {
assertEquals("-1024B", DataSize.ofKiloBytes(-1).toString()); assertEquals("-1024B", DataSize.ofKilobytes(-1).toString());
} }
@Test @Test

Write Preview
Loading…
Cancel
Save