Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish capitalisation of units on DataSize and javadoc of DataUnit

Browse Source 
Issue: SPR-17240
This commit is contained in:
Stephane Nicoll
2018-09-04 13:46:41 +02:00
parent 454cd933d4
commit 2c1dca5b5e
3 changed files with 77 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
spring-core/src/main/java/org/springframework/util/unit/DataSize.java
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})$");
/**
* Bytes per KiloByte.
* Bytes per Kilobyte.
*/
private static long BYTES_PER_KB = 1024;
/**
* Bytes per MegaByte.
* Bytes per Megabyte.
*/
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;
/**
* Bytes per TeraByte.
* Bytes per Terabyte.
*/
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.
* @param kiloBytes the number of kilobytes, positive or negative
* @param kilobytes the number of kilobytes, positive or negative
* @return a {@link DataSize}
*/
public static DataSize ofKiloBytes(long kiloBytes) {
return new DataSize(Math.multiplyExact(kiloBytes, BYTES_PER_KB));
public static DataSize ofKilobytes(long kilobytes) {
return new DataSize(Math.multiplyExact(kilobytes, BYTES_PER_KB));
}
/**
* 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}
*/
public static DataSize ofMegaBytes(long megaBytes) {
return new DataSize(Math.multiplyExact(megaBytes, BYTES_PER_MB));
public static DataSize ofMegabytes(long megabytes) {
return new DataSize(Math.multiplyExact(megabytes, BYTES_PER_MB));
}
/**
* 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}
*/
public static DataSize ofGigaBytes(long gigaBytes) {
return new DataSize(Math.multiplyExact(gigaBytes, BYTES_PER_GB));
public static DataSize ofGigabytes(long gigabytes) {
return new DataSize(Math.multiplyExact(gigabytes, BYTES_PER_GB));
}
/**
* 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}
*/
public static DataSize ofTeraBytes(long teraBytes) {
return new DataSize(Math.multiplyExact(teraBytes, BYTES_PER_TB));
public static DataSize ofTerabytes(long terabytes) {
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
*/
public long toKiloBytes() {
public long toKilobytes() {
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
*/
public long toMegaBytes() {
public long toMegabytes() {
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
*/
public long toGigaBytes() {
public long toGigabytes() {
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
*/
public long toTeraBytes() {
public long toTerabytes() {
return this.bytes / BYTES_PER_TB;
}

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

@@ -32,24 +32,24 @@ public enum DataUnit {
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;

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

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