Package org.apache.shiro.util
Class ByteSource.Util
- java.lang.Object
-
- org.apache.shiro.util.ByteSource.Util
-
- Enclosing interface:
- ByteSource
public static final class ByteSource.Util extends Object
Utility class that can construct ByteSource instances. This is slightly nicer than needing to know theByteSource
implementation class to use.- Since:
- 1.2
-
-
Constructor Summary
Constructors Constructor Description Util()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static ByteSource
bytes(byte[] bytes)
Returns a newByteSource
instance representing the specified byte array.static ByteSource
bytes(char[] chars)
Returns a newByteSource
instance representing the specified character array's bytes.static ByteSource
bytes(File file)
Returns a newByteSource
instance representing the specified File's bytes.static ByteSource
bytes(InputStream stream)
Returns a newByteSource
instance representing the specified InputStream's bytes.static ByteSource
bytes(Object source)
Returns aByteSource
instance representing the specified byte source argument.static ByteSource
bytes(String string)
Returns a newByteSource
instance representing the specified string's bytes.static ByteSource
bytes(ByteSource source)
Returns a newByteSource
instance representing the specified ByteSource.static boolean
isCompatible(Object source)
Returnstrue
if the specified object can be easily represented as aByteSource
using theByteSource.Util
's default heuristics,false
otherwise.
-
-
-
Constructor Detail
-
Util
public Util()
-
-
Method Detail
-
bytes
public static ByteSource bytes(byte[] bytes)
Returns a newByteSource
instance representing the specified byte array.- Parameters:
bytes
- the bytes to represent as aByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified byte array.
-
bytes
public static ByteSource bytes(char[] chars)
Returns a newByteSource
instance representing the specified character array's bytes. The byte array is obtained assumingUTF-8
encoding.- Parameters:
chars
- the character array to represent as aByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified character array's bytes.
-
bytes
public static ByteSource bytes(String string)
Returns a newByteSource
instance representing the specified string's bytes. The byte array is obtained assumingUTF-8
encoding.- Parameters:
string
- the string to represent as aByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified string's bytes.
-
bytes
public static ByteSource bytes(ByteSource source)
Returns a newByteSource
instance representing the specified ByteSource.- Parameters:
source
- the ByteSource to represent as a newByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified ByteSource.
-
bytes
public static ByteSource bytes(File file)
Returns a newByteSource
instance representing the specified File's bytes.- Parameters:
file
- the file to represent as aByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified File's bytes.
-
bytes
public static ByteSource bytes(InputStream stream)
Returns a newByteSource
instance representing the specified InputStream's bytes.- Parameters:
stream
- the InputStream to represent as aByteSource
instance.- Returns:
- a new
ByteSource
instance representing the specified InputStream's bytes.
-
isCompatible
public static boolean isCompatible(Object source)
Returnstrue
if the specified object can be easily represented as aByteSource
using theByteSource.Util
's default heuristics,false
otherwise. This implementation merely returnsSimpleByteSource
.isCompatible(source)
.- Parameters:
source
- the object to test to see if it can be easily converted to ByteSource instances using default heuristics.- Returns:
true
if the specified object can be easily represented as aByteSource
using theByteSource.Util
's default heuristics,false
otherwise.
-
bytes
public static ByteSource bytes(Object source) throws IllegalArgumentException
Returns aByteSource
instance representing the specified byte source argument. If the argument cannot be easily converted to bytes (as is indicated by theisCompatible(Object)
JavaDoc), this method will throw anIllegalArgumentException
.- Parameters:
source
- the byte-backed instance that should be represented as aByteSource
instance.- Returns:
- a
ByteSource
instance representing the specified byte source argument. - Throws:
IllegalArgumentException
- if the argument cannot be easily converted to bytes (as indicated by theisCompatible(Object)
JavaDoc)
-
-