de.javagl.jgltf.model.io

Class IO

java.lang.Object

de.javagl.jgltf.model.io.IO

public class IO
extends java.lang.Object

IO utility methods

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	createInputStream(java.nio.file.Path path) Creates an input stream from the given Path, which may either be an actual (absolute) Path, or a data Path with base64 encoded data
static java.io.InputStream	createInputStream(java.net.URI uri) Creates an input stream from the given URI, which may either be an actual (absolute) URI, or a data URI with base64 encoded data
static boolean	existsUnchecked(java.net.URI uri) Returns whether the resource that is described with the given URI exists.
static java.lang.String	extractFileName(java.net.URI uri) Tries to extract the "file name" that is referred to with the given URI.
static long	getContentLength(java.net.URI uri) Try to obtain the content length from the given URI.
static java.nio.file.Path	getParent(java.nio.file.Path path) Returns the path describing the parent of the given path.
static java.net.URI	getParent(java.net.URI uri) Returns the URI describing the parent of the given URI.
static boolean	isDataUri(java.net.URI uri) Returns whether the given URI is a data URI.
static boolean	isDataUriString(java.lang.String uriString) Returns whether the given string is a data URI.
static java.nio.file.Path	makeAbsolute(java.nio.file.Path basePath, java.lang.String uriString) Convert the given URI string into an absolute path, resolving it against the given base path if necessary
static java.net.URI	makeAbsolute(java.net.URI baseUri, java.lang.String uriString) Convert the given URI string into an absolute URI, resolving it against the given base URI if necessary
static void	read(java.io.InputStream inputStream, byte[] data) Read from the given input stream, writing into the given array, until the array is filled.
static byte[]	read(java.net.URI uri) Read the data from the given URI as a byte array.
static byte[]	readDataUri(java.lang.String uriString) Read the base 64 encoded data from the given data URI string.
static byte[]	readStream(java.io.InputStream inputStream) Reads the data from the given inputStream and returns it as a byte array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

makeAbsolute

public static java.net.URI makeAbsolute(java.net.URI baseUri,
                                        java.lang.String uriString)
                                 throws java.io.IOException

Convert the given URI string into an absolute URI, resolving it against the given base URI if necessary

Parameters:

baseUri - The base URI

uriString - The URI string

Returns:

The absolute URI

Throws:

java.io.IOException - If the URI string is not valid

makeAbsolute

public static java.nio.file.Path makeAbsolute(java.nio.file.Path basePath,
                                              java.lang.String uriString)
                                       throws java.io.IOException

Convert the given URI string into an absolute path, resolving it against the given base path if necessary

Parameters:

basePath - The base path

uriString - The URI string

Returns:

The absolute path

Throws:

java.io.IOException - If the URI string is not valid

getParent

public static java.net.URI getParent(java.net.URI uri)

Returns the URI describing the parent of the given URI. If the given URI describes a file, this will return the URI of the directory. If the given URI describes a directory, this will return the URI of the parent directory

Parameters:

uri - The URI

Returns:

The parent URI

getParent

public static java.nio.file.Path getParent(java.nio.file.Path path)

Returns the path describing the parent of the given path. If the given path describes a file, this will return the path of the directory. If the given path describes a directory, this will return the path of the parent directory

Parameters:

path - The path

Returns:

The parent path

isDataUri

public static boolean isDataUri(java.net.URI uri)

Returns whether the given URI is a data URI.

Parameters:

uri - The URI

Returns:

Whether the string is a data URI

isDataUriString

public static boolean isDataUriString(java.lang.String uriString)

Returns whether the given string is a data URI. If the given string is null, then false will be returned.

Parameters:

uriString - The URI string

Returns:

Whether the string is a data URI

extractFileName

public static java.lang.String extractFileName(java.net.URI uri)

Tries to extract the "file name" that is referred to with the given URI. This is the part behind the last "/" slash that appears in the string representation of the given URI. If no file name can be extracted, then the string representation of the URI is returned.

Parameters:

uri - The URI

Returns:

The file name

existsUnchecked

public static boolean existsUnchecked(java.net.URI uri)

Returns whether the resource that is described with the given URI exists. If an IO exception occurs during this check, this method will simply return false.

Parameters:

uri - The URI

Returns:

Whether the resource exists

getContentLength

public static long getContentLength(java.net.URI uri)

Try to obtain the content length from the given URI. Returns -1 if the content length can not be determined.

Parameters:

uri - The URI

Returns:

The content length

createInputStream

public static java.io.InputStream createInputStream(java.net.URI uri)
                                             throws java.io.IOException

Creates an input stream from the given URI, which may either be an actual (absolute) URI, or a data URI with base64 encoded data

Parameters:

uri - The URI

Returns:

The input stream

Throws:

java.io.IOException - If the stream can not be opened

createInputStream

public static java.io.InputStream createInputStream(java.nio.file.Path path)
                                             throws java.io.IOException

Creates an input stream from the given Path, which may either be an actual (absolute) Path, or a data Path with base64 encoded data

Parameters:

path - The Path

Returns:

The input stream

Throws:

java.io.IOException - If the stream can not be opened

read

public static byte[] read(java.net.URI uri)
                   throws java.io.IOException

Read the data from the given URI as a byte array. The data may either be an actual URI, or a data URI with base64 encoded data.

Parameters:

uri - The URI

Returns:

The byte array

Throws:

java.io.IOException - If an IO error occurs

readDataUri

public static byte[] readDataUri(java.lang.String uriString)

Read the base 64 encoded data from the given data URI string. The data is assumed to start after the base64, part of the URI string, which must have the form data:...;base64,...

Parameters:

uriString - The URI string

Returns:

The data

Throws:

java.lang.IllegalArgumentException - If the given string is not a valid Base64 encoded data URI string

readStream

public static byte[] readStream(java.io.InputStream inputStream)
                         throws java.io.IOException

Reads the data from the given inputStream and returns it as a byte array. The caller is responsible for closing the stream.

Parameters:

inputStream - The input stream to read

Returns:

The data from the inputStream

Throws:

java.io.IOException - If an IO error occurs, or if the thread that executes this method is interrupted.

read

public static void read(java.io.InputStream inputStream,
                        byte[] data)
                 throws java.io.IOException

Read from the given input stream, writing into the given array, until the array is filled.

Parameters:

inputStream - The input stream

data - The array to write the data to

Throws:

java.io.IOException - If an IO error occurs, or the end of the input stream was encountered before the requested number of bytes have been read