org.echocat.jomon.runtime.util

Class ByteCount

java.lang.Object

org.echocat.jomon.runtime.util.ByteCount

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ByteCount>

@ThreadSafe
@Immutable
public class ByteCount
extends java.lang.Object
implements java.lang.Comparable<ByteCount>, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FORMAT_PRECISION

Constructor Summary

Constructors

Constructor and Description
ByteCount(long byteCount)
ByteCount(long count, ByteUnit byteUnit)
ByteCount(java.lang.String combinedByteCount)

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	allocate()
static byte[]	allocate(ByteCount byteCount)
static byte[]	allocate(long byteCount)
static byte[]	allocate(long byteCount, ByteUnit unit)
static byte[]	allocate(java.lang.String byteCount)
java.nio.ByteBuffer	allocateBuffer()
static java.nio.ByteBuffer	allocateBuffer(ByteCount byteCount)
static java.nio.ByteBuffer	allocateBuffer(long byteCount)
static java.nio.ByteBuffer	allocateBuffer(long byteCount, ByteUnit unit)
static java.nio.ByteBuffer	allocateBuffer(java.lang.String byteCount)
static ByteCount	byteCount(long byteCount)
static ByteCount	byteCount(long byteCount, ByteUnit unit)
static ByteCount	byteCount(java.lang.String byteCount)
static ByteCount	byteCountOf(long byteCount)
static ByteCount	byteCountOf(long byteCount, ByteUnit unit)
static ByteCount	byteCountOf(java.lang.String byteCount)
int	compareTo(ByteCount other)
ByteCount	dividedBy(double what)
ByteCount	dividedBy(long what)
boolean	equals(java.lang.Object o)
ByteUnit	getBestFittingUnit()
double	getProcessInRelationTo(ByteCount current)
boolean	hasContent()
int	hashCode()
long	in(ByteUnit byteUnit)
boolean	isEmpty()
boolean	isGreaterThan(ByteCount other)
boolean	isGreaterThanOrEqualTo(ByteCount other)
boolean	isLessThan(ByteCount other)
boolean	isLessThanOrEqualTo(ByteCount other)
ByteCount	minus(ByteCount byteCount)
ByteCount	minus(long byteCount)
ByteCount	minus(long byteCount, ByteUnit unit)
ByteCount	multiplyBy(double what)
ByteCount	multiplyBy(long what)
protected static long	parsePartValueOf(java.util.regex.Matcher matcher)
ByteCount	plus(ByteCount byteCount)
ByteCount	plus(long byteCount)
ByteCount	plus(long byteCount, ByteUnit unit)
ByteCount	plus(java.lang.String byteCount)
long	toByteCount()
static long	toByteCount(java.lang.String combinedByteCount)
int	toByteCountForAllocation()
java.lang.String	toCombinedByteCount()
static java.lang.String	toCombinedByteCount(long byteCount)
java.lang.String	toFormattedByteCount()
java.lang.String	toFormattedByteCount(int precision)
java.lang.String	toFormattedByteCount(java.util.Locale locale)
java.lang.String	toFormattedByteCount(java.util.Locale locale, int precision)
java.lang.String	toFormattedByteCountOf(ByteUnit unit)
java.lang.String	toFormattedByteCountOf(ByteUnit unit, int precision)
java.lang.String	toFormattedByteCountOf(ByteUnit unit, java.util.Locale locale)
java.lang.String	toFormattedByteCountOf(ByteUnit unit, java.util.Locale locale, int precision)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_FORMAT_PRECISION

public static final int DEFAULT_FORMAT_PRECISION

See Also:

Constant Field Values

Constructor Detail

ByteCount

public ByteCount(@Nonnegative
         long byteCount)

ByteCount

public ByteCount(@Nonnegative
         long count,
         @Nonnull
         ByteUnit byteUnit)

ByteCount

public ByteCount(@Nonnull
         java.lang.String combinedByteCount)
          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

Method Detail

toByteCount

@Nonnegative
public static long toByteCount(@Nonnull
                           java.lang.String combinedByteCount)
                        throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

parsePartValueOf

@Nonnegative
protected static long parsePartValueOf(@Nonnull
                                java.util.regex.Matcher matcher)

toCombinedByteCount

@Nonnull
public static java.lang.String toCombinedByteCount(@Nonnegative
                                           long byteCount)

byteCount

@Nullable
public static ByteCount byteCount(@Nullable
                           java.lang.String byteCount)

byteCount

@Nonnull
public static ByteCount byteCount(@Nonnegative
                          long byteCount)

byteCount

@Nonnull
public static ByteCount byteCount(@Nonnegative
                          long byteCount,
                          @Nonnull
                          ByteUnit unit)

byteCountOf

@Nullable
public static ByteCount byteCountOf(@Nullable
                             java.lang.String byteCount)

byteCountOf

@Nonnull
public static ByteCount byteCountOf(@Nonnegative
                            long byteCount)

byteCountOf

@Nonnull
public static ByteCount byteCountOf(@Nonnegative
                            long byteCount,
                            @Nonnull
                            ByteUnit unit)

allocate

@Nonnull
public static byte[] allocate(@Nonnull
                      java.lang.String byteCount)

allocate

@Nonnull
public static byte[] allocate(@Nonnegative
                      long byteCount)

allocate

@Nonnull
public static byte[] allocate(@Nonnegative
                      ByteCount byteCount)

allocate

@Nonnull
public static byte[] allocate(@Nonnegative
                      long byteCount,
                      @Nonnull
                      ByteUnit unit)

allocateBuffer

@Nonnull
public static java.nio.ByteBuffer allocateBuffer(@Nonnull
                                         java.lang.String byteCount)

allocateBuffer

@Nonnull
public static java.nio.ByteBuffer allocateBuffer(@Nonnegative
                                         long byteCount)

allocateBuffer

@Nonnull
public static java.nio.ByteBuffer allocateBuffer(@Nonnegative
                                         ByteCount byteCount)

allocateBuffer

@Nonnull
public static java.nio.ByteBuffer allocateBuffer(@Nonnegative
                                         long byteCount,
                                         @Nonnull
                                         ByteUnit unit)

toByteCount

@Nonnegative
public long toByteCount()

Returns:

the count of all bytes.

allocate

@Nonnull
public byte[] allocate()

allocateBuffer

@Nonnull
public java.nio.ByteBuffer allocateBuffer()

toByteCountForAllocation

@Nonnegative
public int toByteCountForAllocation()
                             throws java.lang.UnsupportedOperationException

Throws:

java.lang.UnsupportedOperationException - if this byteCount exceeds Integer.MAX_VALUE.

in

@Nonnegative
public long in(@Nonnull
                  ByteUnit byteUnit)

toCombinedByteCount

@Nonnull
public java.lang.String toCombinedByteCount()

toFormattedByteCountOf

@Nonnull
public java.lang.String toFormattedByteCountOf(@Nonnull
                                              ByteUnit unit)

toFormattedByteCountOf

@Nonnull
public java.lang.String toFormattedByteCountOf(@Nonnull
                                              ByteUnit unit,
                                              @Nonnegative
                                              int precision)

toFormattedByteCountOf

@Nonnull
public java.lang.String toFormattedByteCountOf(@Nonnull
                                              ByteUnit unit,
                                              @Nullable
                                              java.util.Locale locale)

toFormattedByteCountOf

@Nonnull
public java.lang.String toFormattedByteCountOf(@Nonnull
                                              ByteUnit unit,
                                              @Nullable
                                              java.util.Locale locale,
                                              @Nonnegative
                                              int precision)

toFormattedByteCount

@Nonnull
public java.lang.String toFormattedByteCount()

toFormattedByteCount

@Nonnull
public java.lang.String toFormattedByteCount(@Nonnegative
                                            int precision)

toFormattedByteCount

@Nonnull
public java.lang.String toFormattedByteCount(@Nullable
                                            java.util.Locale locale)

toFormattedByteCount

@Nonnull
public java.lang.String toFormattedByteCount(@Nullable
                                            java.util.Locale locale,
                                            @Nonnegative
                                            int precision)

getBestFittingUnit

@Nonnull
public ByteUnit getBestFittingUnit()

plus

@Nonnull
public ByteCount plus(@Nonnegative
                     long byteCount)

plus

@Nonnull
public ByteCount plus(@Nullable
                     ByteCount byteCount)

plus

@Nonnull
public ByteCount plus(@Nonnegative
                     long byteCount,
                     @Nonnull
                     ByteUnit unit)

plus

@Nonnull
public ByteCount plus(@Nullable
                     java.lang.String byteCount)

minus

@Nonnull
public ByteCount minus(@Nullable
                      ByteCount byteCount)

minus

@Nonnull
public ByteCount minus(@Nonnegative
                      long byteCount)

minus

@Nonnull
public ByteCount minus(@Nonnegative
                      long byteCount,
                      @Nonnull
                      ByteUnit unit)

multiplyBy

@Nonnull
public ByteCount multiplyBy(double what)

dividedBy

@Nonnull
public ByteCount dividedBy(double what)

multiplyBy

@Nonnull
public ByteCount multiplyBy(long what)

dividedBy

@Nonnull
public ByteCount dividedBy(long what)

getProcessInRelationTo

@Nonnegative
public double getProcessInRelationTo(@Nonnull
                                        ByteCount current)

isEmpty

public boolean isEmpty()

hasContent

public boolean hasContent()

isLessThan

public boolean isLessThan(@Nonnull
                 ByteCount other)

isLessThanOrEqualTo

public boolean isLessThanOrEqualTo(@Nonnull
                          ByteCount other)

isGreaterThan

public boolean isGreaterThan(@Nonnull
                    ByteCount other)

isGreaterThanOrEqualTo

public boolean isGreaterThanOrEqualTo(@Nonnull
                             ByteCount other)

compareTo

public int compareTo(@Nonnull
            ByteCount other)

Specified by:

compareTo in interface java.lang.Comparable<ByteCount>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object