- public CompareToBuilder append(boolean lhs, boolean rhs)

Description:
Appends to the builder the comparison of two booleanss.

Parameters:

• lhs - left-hand value
• rhs - right-hand value

- public boolean isEquals()

Description:
Returns true if the fields that have been checked are all equal.

Return Parameters:

• boolean

+ public static boolean equal(File file1, File file2) throws IOException

Description:
Returns true if the files contains the same bytes.

- public HashCodeBuilder append(short value)

Description:
Append a hashCode for a short.

Parameters:

• value - the short to add to the hashCode

- public int toHashCode()

Description:
Return the computed hashCode.

Return Parameters:

• hashCode based on the fields appended

+ public static int hashCode(Object... objects)

Description:
Generates a hash code for multiple values. The hash code is generated by calling Arrays.hashCode(Object[]). This is useful for implementing Object.hashCode(). For example, in an object that has three properties, x, y, and z, one could write: public int hashCode() { return Objects.hashCode(getX(), getY(), getZ()); } Warning: When a single object is supplied, the returned hash code does not equal the hash code of that object.

- public HashCodeBuilder append(short value)

Description:
Append a hashCode for a short.

Parameters:

• value - the short to add to the hashCode

+ public static void append(CharSequence from, File to, Charset charset) throws IOException

Description:
Appends a character sequence (such as a string) to a file using the given character set.

Parameters:

• from - the character sequence to append
• to - the destination file
• charset - the character set used when writing the file

- public static boolean isEmpty(CharSequence cs)

Description:
Checks if a CharSequence is empty ("") or null. StringUtils.isEmpty(null) = true StringUtils.isEmpty("") = true StringUtils.isEmpty(" ") = false StringUtils.isEmpty("bob") = false StringUtils.isEmpty(" bob ") = false NOTE: This method changed in Lang version 2.0. It no longer trims the CharSequence. That functionality is available in isBlank().

Parameters:

• cs - the CharSequence to check, may be null

+ public static boolean isNullOrEmpty(@Nullable String string)

Description:
Returns true if the given string is null or is the empty string. Consider normalizing your string references with nullToEmpty(java.lang.String). If you do, you can use String.isEmpty() instead of this method, and you won't need special null-safe forms of methods like String.toUpperCase(java.util.Locale) either. Or, if you'd like to normalize "in the other direction," converting empty strings to null, you can use emptyToNull(java.lang.String).

Parameters:

• string - a string reference to check

- public static String leftPad(String str, int size)

Description:
Left pad a String with spaces (' '). The String is padded to the size of size. StringUtils.leftPad(null, *) = null StringUtils.leftPad("", 3) = " " StringUtils.leftPad("bat", 3) = "bat" StringUtils.leftPad("bat", 5) = " bat" StringUtils.leftPad("bat", 1) = "bat" StringUtils.leftPad("bat", -1) = "bat"

Parameters:

• str - the String to pad out, may be null
• size - the size to pad to

+ public static String repeat(String string, int count)

Description:
Returns a string consisting of a specific number of concatenated copies of an input string. For example, repeat("hey", 3) returns the string "heyheyhey".

Parameters:

• string - any non-null string
• count - the number of times to repeat it; a nonnegative integer

- public Directory getDirectory()

Description:
Returns the Directory used by this index.

- public void close()

Description:
Frees persistent resources used by this Analyzer

+ public void close()

Description:
Closes the transaction factory.

- public Directory getDirectory()

Description:
Returns the Directory used by this index.

- public Analyzer getAnalyzer()

Description:
Returns the analyzer used by this index.

- public IndexSearcher(IndexReader r)

Description:
Creates a searcher searching the provided index.

+ public CompassSession openSession()

Description:
If there is a transaction bound session, will return it. Otherwise returns a new session. A transactional bound session is bounded to the transaction when calling the CompassSession.beginTransaction() or if Compass tries to automatically join an already running transaction (see next paragraph). If creating a new session, will try to automatically join an existing outer transaction. An outer transaction might be an already running Compass local transaction, or an external transaciton (JTA or Spring for example). In such cases, there is no need to perform any transaction managment code (begin or commit/rollback transaction) or closing the opened session. Compass will also bind the session to the same transaction if an outer transaction exists. Note, when doing so, the mentioned code will have to always be excuted within an already running transaction.

Return Parameters:

• CompassSession The compass session

- public V get(Object key)

Description:
Returns the value for the given key.

+ public Object get(Object key)

Description:
Specified by: get in interface Map

- public boolean contains(Object o)

Description:
Specified by: contains in interface Collection<Object> Specified by: contains in interface Set<Object> Overrides: contains in class AbstractCollection<Object>

+ public boolean contains(Object o)

Description:
Specified by: contains in interface Collection Specified by: contains in interface Set Overrides: contains in class AbstractCollection

- public final T add(T element)

Description:
Adds an Object to a PriorityQueue in log(size) time. If one tries to add more objects than maxSize from initialize an ArrayIndexOutOfBoundsException is thrown.

Return Parameters:

• the new 'top' element in the queue.

+ public CompassQueryBuilder.CompassMoreLikeThisQuery addProperty(String property)

Description:
Adds a property to the more like this query will be performed on.

- public final void commit() throws CorruptIndexException, IOException

Description:
Commits all pending changes (added & deleted documents, optimizations, segment merges, added indexes, etc.) to the index, and syncs all referenced index files, such that a reader will see the changes and the index updates will survive an OS or machine crash or power loss. Note that this does not wait for any running background merges to finish. This may be a costly operation, so you should test the cost in your application and do it only when really necessary. Note that this operation calls Directory.sync on the index files. That call should not return until the file contents & metadata are on stable storage. For FSDirectory, this calls the OS's fsync. But, beware: some hardware devices may in fact cache writes even during fsync, and return before the bits are actually on stable storage, to give the appearance of faster performance. If you have such a device, and it does not have a battery backup (for example) then on power loss it may still lose data. Lucene cannot guarantee consistency on such devices. NOTE: if this method hits an OutOfMemoryError you should immediately close the writer. See above for details.

+ public void commit() throws CompassException

Description:
Same as CompassSession.close().

- public Term(String fld, String txt)

Description:
Constructs a Term with the given field and text. Note that a null field or null text value results in undefined behavior for most Lucene APIs that accept a Term parameter.

+ public Resource getResource(Class clazz, Object id) throws CompassException

Description:
Returns a Resource that match the mapping specified for the defined class type, and specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

• clazz - The class that represents the required mapping
• id - The id that identifies the resource

- public TopDocs search(Query query, int n) throws IOException

Description:
Finds the top n hits for query.

+ public Resource getResource(Class clazz, Object id) throws CompassException

Description:
Returns a Resource that match the mapping specified for the defined class type, and specified id. The id can be an object of the class (with the id attributes set), an array of id objects, or the actual id object. Returns null if the object is not found.

Parameters:

• clazz - The class that represents the required mapping
• id - The id that identifies the resource

+ public CompassQueryBuilder queryBuilder() throws CompassException

Description:
Creats a new query builder, used to build queries programmatically.

Return Parameters:

• The query builder.

+ public CompassQuery term(String name, Object value)

Description:
Creates a query where the resource property must have the given value. Note, that the value itself will not be analyzed, but the text that was indexed might have been (if indexed). The search is case sensative. The name can either be the actual resource property or meta-data value, or the path to the given resource property (alias.rProperty), or the class property (alias.cProperty) or the path to the meta-data (alias.cProperty.metaData)

Parameters:

• name - The resource property name
• value - The value that must match

+ public CompassHits hits() throws CompassException

Description:
Performs the search and returns the hits that match the qeury.

- public void addDocument(Document doc) throws CorruptIndexException, IOException

Description:
Adds a document to this index. If the document contains more than setMaxFieldLength(int) terms for a given field, the remainder are discarded. Note that if an Exception is hit (for example disk full) then the index will be consistent, but this document may not have been added. Furthermore, it's possible the index will have one segment in non-compound format even when using compound files (when a merge has partially succeeded). This method periodically flushes pending documents to the Directory (see above), and also periodically triggers segment merges in the index according to the MergePolicy in use. Merges temporarily consume space in the directory. The amount of space required is up to 1X the size of all segments being merged, when no readers/searchers are open against the index, and up to 2X the size of all segments being merged when readers/searchers are open against the index (see optimize() for details). The sequence of primitive merge operations performed is governed by the merge policy. Note that each term in the document can be no longer than 16383 characters, otherwise an IllegalArgumentException will be thrown. Note that it's possible to create an invalid Unicode string in java if a UTF16 surrogate pair is malformed. In this case, the invalid characters are silently replaced with the Unicode replacement character U+FFFD. NOTE: if this method hits an OutOfMemoryError you should immediately close the writer. See above for details.

+ public void save(Object obj) throws CompassException

Description:
Saves an object in Compass. All the meta data defined in the Compass mapping files will be indexed and saved for later searching.

Parameters:

• obj - The object to save.

- public void close()

Description:
Frees persistent resources used by this Analyzer

- public void close()

Description:
Frees persistent resources used by this Analyzer

+ public void close()

Description:
Closes the transaction factory.

- public void rollback() throws IOException

Description:
Close the IndexWriter without committing any changes that have occurred since the last commit (or since it was opened, if commit hasn't been called). This removes any temporary files that had been created, after which the state of the index will be the same as it was when commit() was last called or when this writer was first opened. This also clears a previous call to prepareCommit().

+ public void rollback() throws CompassException

Description:
When not using explicit CompassTransaction in order to manage transactions, can be called to rollback the current running transaction. Effectively also closes the session.

- public void updateDocument(Term term, Document doc) throws CorruptIndexException, IOException

Description:
Updates a document by first deleting the document(s) containing term and then adding the new document. The delete and then add are atomic as seen by a reader on the same index (flush may happen only after the add). NOTE: if this method hits an OutOfMemoryError you should immediately close the writer. See above for details.

Parameters:

• term - the term to identify the document(s) to be deleted
• doc - the document to be added

+ public void save(Object obj) throws CompassException

Description:
Saves an object in Compass. All the meta data defined in the Compass mapping files will be indexed and saved for later searching.

Parameters:

• obj - The object to save.

- public HashCodeBuilder append(short value)

Description:
Append a hashCode for a short.

Parameters:

• value - the short to add to the hashCode

+ public static void append(CharSequence from, File to, Charset charset) throws IOException

Description:
Appends a character sequence (such as a string) to a file using the given character set.

Parameters:

• from - the character sequence to append
• to - the destination file
• charset - the character set used when writing the file

- public static boolean isEmpty(CharSequence cs)

Description:
Checks if a CharSequence is empty ("") or null. StringUtils.isEmpty(null) = true StringUtils.isEmpty("") = true StringUtils.isEmpty(" ") = false StringUtils.isEmpty("bob") = false StringUtils.isEmpty(" bob ") = false NOTE: This method changed in Lang version 2.0. It no longer trims the CharSequence. That functionality is available in isBlank().

Parameters:

• cs - the CharSequence to check, may be null

+ public static boolean isNullOrEmpty(@Nullable String string)

Description:
Returns true if the given string is null or is the empty string. Consider normalizing your string references with nullToEmpty(java.lang.String). If you do, you can use String.isEmpty() instead of this method, and you won't need special null-safe forms of methods like String.toUpperCase(java.util.Locale) either. Or, if you'd like to normalize "in the other direction," converting empty strings to null, you can use emptyToNull(java.lang.String).

Parameters:

• string - a string reference to check

- public static String leftPad(String str, int size)

Description:
Left pad a String with spaces (' '). The String is padded to the size of size. StringUtils.leftPad(null, *) = null StringUtils.leftPad("", 3) = " " StringUtils.leftPad("bat", 3) = "bat" StringUtils.leftPad("bat", 5) = " bat" StringUtils.leftPad("bat", 1) = "bat" StringUtils.leftPad("bat", -1) = "bat"

Parameters:

• str - the String to pad out, may be null
• size - the size to pad to

+ public static String repeat(String string, int count)

Description:
Returns a string consisting of a specific number of concatenated copies of an input string. For example, repeat("hey", 3) returns the string "heyheyhey".

Parameters:

• string - any non-null string
• count - the number of times to repeat it; a nonnegative integer

- public static String toString(byte[] input) throws IOException

Description:
Deprecated. Use String.String(byte[])

Parameters:

• input - the byte array to read from

+ public static String toString(InputSupplier supplier) throws IOException

Description:
Returns the characters from a Readable & Closeable object supplied by a factory as a String.

Parameters:

• supplier - the factory to read from

- public static String toString(byte[] input) throws IOException

Description:
Deprecated. Use String.String(byte[])

Parameters:

• input - the byte array to read from

+ public static String toString(URL url, Charset charset) throws IOException

Description:
Reads all characters from a URL into a String, using the given character set.

Parameters:

• url - the URL to read from
• charset - the character set used when reading the URL

- public static String toString(byte[] input, String encoding) throws IOException

Description:
Deprecated. Use String.String(byte[],String)

Parameters:

• input - the byte array to read from
• encoding - the encoding to use, null means platform default

+ public static String toString(URL url, Charset charset) throws IOException

Description:
Reads all characters from a URL into a String, using the given character set.

Parameters:

• url - the URL to read from
• charset - the character set used when reading the URL

- public static List readLines(Reader input) throws IOException

Description:
Get the contents of a Reader as a list of Strings, one entry per line. This method buffers the input internally, so there is no need to use a BufferedReader.

Parameters:

• input - the Reader to read from, not null

+ public static List readLines(Readable r) throws IOException

Description:
Reads all of the lines from a Readable object. The lines do not include line-termination characters, but do include other leading and trailing whitespace. Does not close the Readable. If reading files or resources you should use the Files.readLines(java.io.File, java.nio.charset.Charset) and Resources.readLines(java.net.URL, java.nio.charset.Charset, com.google.common.io.LineProcessor ) methods.

Parameters:

• r - the object to read from

+ public static URL getResource(Class contextClass, String resourceName)

Description:
Returns a URL pointing to resourceName that is relative to contextClass, if the resource is found in the class path.

- public static long checksumCRC32(File file) throws IOException

Description:
Computes the checksum of a file using the CRC32 checksum routine. The value of the checksum is returned.

Parameters:

• file - the file to checksum, must not be null

+ public static long getChecksum(File file, Checksum checksum) throws IOException

Description:
Computes and returns the checksum value for a file. The checksum object is reset when this method returns successfully.

Parameters:

• file - the file to read
• checksum - the checksum object

- public static void closeQuietly(OutputStream output)

Description:
Unconditionally close an OutputStream. Equivalent to OutputStream.close(), except any exceptions will be ignored. This is typically used in finally blocks.

Parameters:

• output - the OutputStream to close, may be null or already closed

+ public static void closeQuietly(@Nullable Closeable closeable)

Description:
Equivalent to calling close(closeable, true), but with no IOException in the signature.

Parameters:

• closeable - the Closeable object to be closed, or null, in which case this method does nothing

- public static void copy(Reader input, OutputStream output) throws IOException

Description:
Deprecated.

Parameters:

• input - the Reader to read from
• output - the OutputStream to write to

+ public static long copy(Readable from, Appendable to) throws IOException

Description:
Copies all characters between the Readable and Appendable objects. Does not close or flush either object.

Parameters:

• from - the object to read from
• to - the object to write to

- public static void copy(Reader input, OutputStream output) throws IOException

Description:
Deprecated.

Parameters:

• input - the Reader to read from
• output - the OutputStream to write to

+ public static long copy(ReadableByteChannel from, WritableByteChannel to) throws IOException

Description:
Copies all bytes from the readable channel to the writable channel. Does not close or flush either channel.

Parameters:

• from - the readable channel to read from
• to - the writable channel to write to

- public static void copy(Reader input, OutputStream output) throws IOException

Description:
Deprecated.

Parameters:

• input - the Reader to read from
• output - the OutputStream to write to

+ public static void copy(URL from, OutputStream to) throws IOException

Description:
Copies all bytes from a URL to an output stream.

Parameters:

• from - the URL to read from
• to - the output stream

- public static void deleteDirectory(File directory) throws IOException

Description:
Deletes a directory recursively.

Parameters:

• directory - directory to delete

+ public static void deleteRecursively(File file) throws IOException

Description:
Deletes a file or directory and all contents recursively. If the file argument is a symbolic link the link will be deleted but not the target of the link. If the argument is a directory, symbolic links within the directory will not be followed.

Parameters:

• file - the file to delete

- public static void forceMkdir(File directory) throws IOException

Description:
Makes a directory, including any necessary but nonexistent parent directories. If there already exists a file with specified name or the directory cannot be created then an exception is thrown.

Parameters:

• directory - directory to create, must not be null

+ public static void createParentDirs(File file) throws IOException

Description:
Creates any necessary but nonexistent parent directories of the specified file. Note that if this operation fails it may have succeeded in creating some (but not all) of the necessary parent directories.

+ public void stop(StopEvent evt)

Description:
Specified by: stop in interface MediaListener

+ public VideoComponent()

Description:
Creates a new instance of GstVideoComponent

+ public void setVideoSink(Element element)

Description:
Sets the video output Element. To disable video output, call this method with a null argument.

Parameters:

• element - The element to use for video output.

+ void play()

Description:
Starts playing the media (as set by setURI(java.net.URI).

+ public void positionChanged(PositionChangedEvent evt)

Description:
Specified by: positionChanged in interface MediaListener

+ public void pause(StopEvent evt)

Description:
Specified by: pause in interface MediaListener

+ public void endOfMedia(EndOfMediaEvent evt)

Description:
Specified by: endOfMedia in interface MediaListener

+ public void durationChanged(DurationChangedEvent evt)

Description:
Specified by: durationChanged in interface MediaListener

+ public static final void init() throws GstException

Description:
Initializes the GStreamer library. This is a shortcut if no arguments are to be passed to gstreamer.

+ public void setURI(java.net.URI uri)

Description:
Sets the media URI to play.

Parameters:

• uri - The URI to play.

+ public void addMediaListener(MediaListener listener)

Description:
Adds a MediaListener that will be notified of media events.

Parameters:

• listener - the MediaListener to add.

+ public void start(StartEvent evt)

Description:
Specified by: start in interface MediaListener

+ public void start(StartEvent evt)

Description:
Specified by: start in interface MediaListener

- T accept(MediaType... types)

Description:
Add acceptable media types.

Parameters:

• types - an array of the acceptable media types

- java.util.concurrent.Future get(GenericType gt) throws UniformInterfaceException

Description:
Invoke the GET method. The Future.get() method will throw a UniformInterfaceException if the status of the HTTP response is greater than or equal to 300 and gt is not the type ClientResponse.

- public WebResource resource(java.net.URI u)

Description:
Create a Web resource from the client.

Parameters:

• u - the URI of the resource.