Scaladoc for kafka.utils.Utils

Inherited

Hide All
Show all

AnyRef
Any

Visibility

Public
All

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
def !=(arg0: Any): Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ##(): Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf[T0](): T0

attributes: final
definition classes: AnyRef
def $isInstanceOf[T0](): Boolean

attributes: final
definition classes: AnyRef
def ==(arg0: AnyRef): Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def ==(arg0: Any): Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def asInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def clone(): AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def crc32(bytes: Array[Byte], offset: Int, size: Int): Long

Compute the CRC32 of the segment of the byte array given by the specificed size and offset

Compute the CRC32 of the segment of the byte array given by the specificed size and offset
bytes
The bytes to checksum
returns
The CRC32
def crc32(bytes: Array[Byte]): Long

Compute the CRC32 of the byte array

Compute the CRC32 of the byte array
bytes
The array to compute the checksum for
returns
The CRC32
def croak(message: String): Unit

Print an error message and shutdown the JVM

Print an error message and shutdown the JVM
message
The error message
def daemonThread(name: String, fun: () ⇒ Unit): Thread

Create a daemon thread

Create a daemon thread
name
The name of the thread
fun
The runction to execute in the thread
returns
The unstarted thread
def daemonThread(name: String, runnable: Runnable): Thread

Create a daemon thread

Create a daemon thread
name
The name of the thread
runnable
The runnable to execute in the background
returns
The unstarted thread
def eq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equal(b1: ByteBuffer, b2: ByteBuffer): Boolean

Test if two byte buffers are equal.

Test if two byte buffers are equal. In this case equality means having the same bytes from the current position to the limit
def equals(arg0: Any): Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getBoolean(props: Properties, name: String, default: Boolean): Boolean

Read a boolean value from the properties instance

Read a boolean value from the properties instance
props
The properties to read from
name
The property name
default
The default value to use if the property is not found
returns
the boolean value
def getCSVList(csvList: String): Seq[String]
def getClass(): java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def getCompressionCodec(props: Properties, codec: String): CompressionCodec
def getConsumerTopicMap(consumerTopicString: String): Map[String, Int]
def getHostPort(hostport: String): (String, Int)
def getInt(props: Properties, name: String, default: Int): Int

Read an integer from the properties instance

Read an integer from the properties instance
props
The properties to read from
name
The property name
default
The default value to use if the property is not found
returns
the integer value
def getInt(props: Properties, name: String): Int

Read a required integer property value or throw an exception if no such property is found

Read a required integer property value or throw an exception if no such property is found
def getIntInRange(props: Properties, name: String, default: Int, range: (Int, Int)): Int

Read an integer from the properties instance.

Read an integer from the properties instance. Throw an exception if the value is not in the given range (inclusive)
props
The properties to read from
name
The property name
default
The default value to use if the property is not found
range
The range in which the value must fall (inclusive)
returns
the integer value
def getObject[T <: AnyRef](className: String): T
def getProps(props: Properties, name: String, default: Properties): Properties

Get a property of type java.

Get a property of type java.util.Properties or return the default if no such property is defined
def getProps(props: Properties, name: String): Properties

Get a property of type java.

Get a property of type java.util.Properties or throw and exception if no such property is defined.
def getString(props: Properties, name: String): String

Get a string property or throw and exception if no such property is defined.

Get a string property or throw and exception if no such property is defined.
def getString(props: Properties, name: String, default: String): String

Get a string property, or, if no such property is defined, return the given default value

Get a string property, or, if no such property is defined, return the given default value
def getTopicFlushIntervals(allIntervals: String): Map[String, Int]
def getTopicPartition(topicPartition: String): (String, Int)
def getTopicPartitions(allPartitions: String): Map[String, Int]
def getTopicRentionHours(retentionHours: String): Map[String, Int]
def getUnsignedInt(buffer: ByteBuffer, index: Int): Long

Read an unsigned integer from the given position without modifying the buffers position

Read an unsigned integer from the given position without modifying the buffers position
index
the index from which to read the integer
returns
The integer read, as a long to avoid signedness
def getUnsignedInt(buffer: ByteBuffer): Long

Read an unsigned integer from the current position in the buffer, incrementing the position by 4 bytes

Read an unsigned integer from the current position in the buffer, incrementing the position by 4 bytes
returns
The integer read, as a long to avoid signedness
def groupby[K, V](vals: Iterable[V], f: (V) ⇒ K): Map[K, List[V]]

Group the given values by keys extracted with the given function

Group the given values by keys extracted with the given function
def hashCode(): Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
def hashcode(as: Any*): Int

Compute the hash code for the given items

Compute the hash code for the given items
def isInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def loadProps(filename: String): Properties

Read a properties file from the given path

Read a properties file from the given path
filename
The path of the file to read
def loggedRunnable(fun: () ⇒ Unit): Runnable

Wrap the given function in a java.

Wrap the given function in a java.lang.Runnable that logs any errors encountered
fun
A function
returns
A Runnable that just executes the function
def ne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def newThread(name: String, runnable: Runnable, daemon: Boolean): Thread

Create a new thread

Create a new thread
name
The name of the thread
runnable
The work for the thread to do
daemon
Should the thread block JVM shutdown?
returns
The unstarted thread
def notNull[V](v: V): V
def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def openChannel(file: File, mutable: Boolean): FileChannel

Open a channel for the given file

Open a channel for the given file
def propertyExists(prop: String): Boolean
def putUnsignedInt(buffer: ByteBuffer, index: Int, value: Long): Unit

Write the given long value as a 4 byte unsigned integer.

Write the given long value as a 4 byte unsigned integer. Overflow is ignored.
buffer
The buffer to write to
index
The position in the buffer at which to begin writing
value
The value to write
def putUnsignedInt(buffer: ByteBuffer, value: Long): Unit

Write the given long value as a 4 byte unsigned integer.

Write the given long value as a 4 byte unsigned integer. Overflow is ignored.
buffer
The buffer to write to
value
The value to write
def read(channel: ReadableByteChannel, buffer: ByteBuffer): Int

Read some bytes into the provided buffer, and return the number of bytes read.

Read some bytes into the provided buffer, and return the number of bytes read. If the channel has been closed or we get -1 on the read for any reason, throw an EOFException
def readBytes(buffer: ByteBuffer, offset: Int, size: Int): Array[Byte]

Read a byte array from the given offset and size in the buffer TODO: Should use System.

Read a byte array from the given offset and size in the buffer TODO: Should use System.arraycopy
def readShortString(buffer: ByteBuffer, encoding: String): String

Read size prefixed string where the size is stored as a 2 byte short.

Read size prefixed string where the size is stored as a 2 byte short.
buffer
The buffer to read from
encoding
The encoding in which to read the string
def registerMBean(mbean: AnyRef, name: String): Unit

Register the given mbean with the platform mbean server, unregistering any mbean that was there before

Register the given mbean with the platform mbean server, unregistering any mbean that was there before
mbean
The object to register as an mbean
name
The name to register this mbean with
def rm(file: File): Unit

Recursively delete the given file/directory and any subfiles (if any exist)

Recursively delete the given file/directory and any subfiles (if any exist)
file
The root file at which to begin deleting
def rm(file: String): Unit

Recursively delete the given file/directory and any subfiles (if any exist)

Recursively delete the given file/directory and any subfiles (if any exist)
file
The root file at which to begin deleting
def runnable(fun: () ⇒ Unit): Runnable

Wrap the given function in a java.

Wrap the given function in a java.lang.Runnable
fun
A function
returns
A Runnable that just executes the function
def stackTrace(e: Throwable): String
def swallow(log: (AnyRef, Throwable) ⇒ Unit, action: ⇒ Unit): Unit

Do the given action and log any exceptions thrown without rethrowing them

Do the given action and log any exceptions thrown without rethrowing them
log
The log method to use for logging. E.g. logger.warn
action
The action to execute
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def toString(buffer: ByteBuffer, encoding: String): String

Translate the given buffer into a string

Translate the given buffer into a string
buffer
The buffer to translate
encoding
The encoding to use in translating bytes to characters
def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
def unregisterMBean(name: String): Unit

Unregister the mbean with the given name, if there is one registered

Unregister the mbean with the given name, if there is one registered
name
The mbean name to unregister
def wait(): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long, arg1: Int): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long): Unit

attributes: final
definition classes: AnyRef
def writeShortString(buffer: ByteBuffer, string: String, encoding: String): Unit

Write a size prefixed string where the size is stored as a 2 byte short

Write a size prefixed string where the size is stored as a 2 byte short
buffer
The buffer to write to
string
The string to write
encoding
The encoding in which to write the string

Utils

object Utils extends AnyRef

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

def asInstanceOf[T0]: T0

def clone(): AnyRef

def crc32(bytes: Array[Byte], offset: Int, size: Int): Long

def crc32(bytes: Array[Byte]): Long

def croak(message: String): Unit

def daemonThread(name: String, fun: () ⇒ Unit): Thread

def daemonThread(name: String, runnable: Runnable): Thread

def eq(arg0: AnyRef): Boolean

def equal(b1: ByteBuffer, b2: ByteBuffer): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def getBoolean(props: Properties, name: String, default: Boolean): Boolean

def getCSVList(csvList: String): Seq[String]

def getClass(): java.lang.Class[_]

def getCompressionCodec(props: Properties, codec: String): CompressionCodec

def getConsumerTopicMap(consumerTopicString: String): Map[String, Int]

def getHostPort(hostport: String): (String, Int)

def getInt(props: Properties, name: String, default: Int): Int

def getInt(props: Properties, name: String): Int

def getIntInRange(props: Properties, name: String, default: Int, range: (Int, Int)): Int

def getObject[T <: AnyRef](className: String): T

def getProps(props: Properties, name: String, default: Properties): Properties

def getProps(props: Properties, name: String): Properties

def getString(props: Properties, name: String): String

def getString(props: Properties, name: String, default: String): String

def getTopicFlushIntervals(allIntervals: String): Map[String, Int]

def getTopicPartition(topicPartition: String): (String, Int)

def getTopicPartitions(allPartitions: String): Map[String, Int]

def getTopicRentionHours(retentionHours: String): Map[String, Int]

def getUnsignedInt(buffer: ByteBuffer, index: Int): Long

def getUnsignedInt(buffer: ByteBuffer): Long

def groupby[K, V](vals: Iterable[V], f: (V) ⇒ K): Map[K, List[V]]

def hashCode(): Int

def hashcode(as: Any*): Int

def isInstanceOf[T0]: Boolean

def loadProps(filename: String): Properties

def loggedRunnable(fun: () ⇒ Unit): Runnable

def ne(arg0: AnyRef): Boolean

def newThread(name: String, runnable: Runnable, daemon: Boolean): Thread

def notNull[V](v: V): V

def notify(): Unit

def notifyAll(): Unit

def openChannel(file: File, mutable: Boolean): FileChannel

def propertyExists(prop: String): Boolean

def putUnsignedInt(buffer: ByteBuffer, index: Int, value: Long): Unit

def putUnsignedInt(buffer: ByteBuffer, value: Long): Unit

def read(channel: ReadableByteChannel, buffer: ByteBuffer): Int

def readBytes(buffer: ByteBuffer, offset: Int, size: Int): Array[Byte]

def readShortString(buffer: ByteBuffer, encoding: String): String

def registerMBean(mbean: AnyRef, name: String): Unit

def rm(file: File): Unit

def rm(file: String): Unit

def runnable(fun: () ⇒ Unit): Runnable

def stackTrace(e: Throwable): String

def swallow(log: (AnyRef, Throwable) ⇒ Unit, action: ⇒ Unit): Unit

def synchronized[T0](arg0: T0): T0

def toString(buffer: ByteBuffer, encoding: String): String

def toString(): String

def unregisterMBean(name: String): Unit

def wait(): Unit

def wait(arg0: Long, arg1: Int): Unit

def wait(arg0: Long): Unit

def writeShortString(buffer: ByteBuffer, string: String, encoding: String): Unit