Package org.codehaus.groovy.runtime
Class EncodingGroovyMethods
java.lang.Object
org.codehaus.groovy.runtime.EncodingGroovyMethods
This class defines all the encoding/decoding groovy methods which enhance
 the normal JDK classes when inside the Groovy environment.
 Static methods are used with the first parameter the destination class.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionstatic byte[]decodeBase64(String value) Decode the String from Base64 into a byte array.static byte[]decodeBase64Url(String value) Decodes a Base64 URL and Filename Safe encoded String into a byte array.static byte[]Decodes a hex string to a byte array.static Stringdigest the byte arraystatic Stringdigest(CharSequence self, String algorithm) digest the CharSequence instancestatic WritableencodeBase64(byte[] data) Produce a Writable object which writes the Base64 encoding of the byte array.static WritableencodeBase64(byte[] data, boolean chunked) Produce a Writable object which writes the Base64 encoding of the byte array.static WritableencodeBase64(Byte[] data) Produce a Writable object which writes the Base64 encoding of the byte array.static WritableencodeBase64(Byte[] data, boolean chunked) Produce a Writable object which writes the Base64 encoding of the byte array.static WritableencodeBase64Url(byte[] data) Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.static WritableencodeBase64Url(byte[] data, boolean pad) Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.static WritableencodeBase64Url(Byte[] data) Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.static WritableencodeBase64Url(Byte[] data, boolean pad) Produce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array.static WritableencodeHex(byte[] data) Produces a Writable that writes the hex encoding of the byte[].static WritableProduces a Writable that writes the hex encoding of the Byte[].static Stringmd5(byte[] self) Calculate md5 of the byte arraystatic Stringmd5(CharSequence self) Calculate md5 of the CharSequence instancestatic Stringsha256(byte[] self) Calculate SHA-256 of the byte arraystatic Stringsha256(CharSequence self) Calculate SHA-256 of the CharSequence instance
- 
Constructor Details- 
EncodingGroovyMethodspublic EncodingGroovyMethods()
 
- 
- 
Method Details- 
encodeBase64Produce a Writable object which writes the Base64 encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 encoding and chunking seeRFC 4648.- Parameters:
- data- Byte array to be encoded
- chunked- whether the Base64 encoded data should be MIME chunked
- Returns:
- object which will write the Base64 encoding of the byte array
- Since:
- 1.5.1
 
- 
encodeBase64Produce a Writable object which writes the Base64 encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 encoding and chunking seeRFC 4648.- Parameters:
- data- Byte array to be encoded
- Returns:
- object which will write the Base64 encoding of the byte array
- Since:
- 1.0
 
- 
encodeBase64Produce a Writable object which writes the Base64 encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 encoding and chunking seeRFC 4648.- Parameters:
- data- byte array to be encoded
- chunked- whether the Base64 encoded data should be MIME chunked
- Returns:
- object which will write the Base64 encoding of the byte array
- Since:
- 1.5.7
 
- 
encodeBase64Produce a Writable object which writes the Base64 encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 encoding and chunking seeRFC 4648.- Parameters:
- data- byte array to be encoded
- Returns:
- object which will write the Base64 encoding of the byte array
- Since:
- 1.0
 
- 
encodeBase64UrlProduce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 URL and Filename Safe encoding seeRFC 4648 - Section 5 Base 64 Encoding with URL and Filename Safe Alphabet.The method omits padding and is equivalent to calling encodeBase64Url(Byte[], boolean)with a value offalse.- Parameters:
- data- Byte array to be encoded
- Returns:
- object which will write the Base64 URL and Filename Safe encoding of the byte array
- Since:
- 2.5.0
- See Also:
 
- 
encodeBase64UrlProduce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 URL and Filename Safe encoding seeRFC 4648 - Section 5 Base 64 Encoding with URL and Filename Safe Alphabet.- Parameters:
- data- Byte array to be encoded
- pad- whether the encoded data should be padded
- Returns:
- object which will write the Base64 URL and Filename Safe encoding of the byte array
- Since:
- 2.5.0
 
- 
encodeBase64UrlProduce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 URL and Filename Safe encoding seeRFC 4648 - Section 5 Base 64 Encoding with URL and Filename Safe Alphabet.The method omits padding and is equivalent to calling encodeBase64Url(byte[], boolean)with a value offalse.- Parameters:
- data- Byte array to be encoded
- Returns:
- object which will write the Base64 URL and Filename Safe encoding of the byte array
- Since:
- 2.5.0
- See Also:
 
- 
encodeBase64UrlProduce a Writable object which writes the Base64 URL and Filename Safe encoding of the byte array. Calling toString() on the result returns the encoding as a String. For more information on Base64 URL and Filename Safe encoding seeRFC 4648 - Section 5 Base 64 Encoding with URL and Filename Safe Alphabet.- Parameters:
- data- Byte array to be encoded
- pad- whether the encoded data should be padded
- Returns:
- object which will write the Base64 URL and Filename Safe encoding of the byte array
- Since:
- 2.5.0
 
- 
decodeBase64Decode the String from Base64 into a byte array.- Parameters:
- value- the string to be decoded
- Returns:
- the decoded bytes as an array
- Since:
- 1.0
 
- 
decodeBase64UrlDecodes a Base64 URL and Filename Safe encoded String into a byte array.- Parameters:
- value- the string to be decoded
- Returns:
- the decoded bytes as an array
- Since:
- 2.5.0
 
- 
encodeHexProduces a Writable that writes the hex encoding of the Byte[]. Calling toString() on this Writable returns the hex encoding as a String. The hex encoding includes two characters for each byte and all letters are lower case.- Parameters:
- data- byte array to be encoded
- Returns:
- object which will write the hex encoding of the byte array
- See Also:
 
- 
encodeHexProduces a Writable that writes the hex encoding of the byte[]. Calling toString() on this Writable returns the hex encoding as a String. The hex encoding includes two characters for each byte and all letters are lower case.- Parameters:
- data- byte array to be encoded
- Returns:
- object which will write the hex encoding of the byte array
- See Also:
 
- 
decodeHexDecodes a hex string to a byte array. The hex string can contain either upper case or lower case letters.- Parameters:
- value- string to be decoded
- Returns:
- decoded byte array
- Throws:
- NumberFormatException- If the string contains an odd number of characters or if the characters are not valid hexadecimal values.
 
- 
md5Calculate md5 of the CharSequence instance- Returns:
- md5 value
- Throws:
- NoSuchAlgorithmException- if MD5 algorithm not found
- Since:
- 2.5.0
 
- 
md5Calculate md5 of the byte array- Returns:
- md5 value
- Throws:
- NoSuchAlgorithmException- if MD5 algorithm not found
- Since:
- 2.5.0
 
- 
sha256Calculate SHA-256 of the CharSequence instance- Returns:
- SHA-256 value
- Throws:
- NoSuchAlgorithmException- if SHA-256 algorithm not found
- Since:
- 2.5.3
 
- 
sha256Calculate SHA-256 of the byte array- Returns:
- SHA-256 value
- Throws:
- NoSuchAlgorithmException- if SHA-256 algorithm not found
- Since:
- 2.5.3
 
- 
digestdigest the CharSequence instance- Parameters:
- algorithm- the name of the algorithm requested, e.g. MD5, SHA-1, SHA-256, etc.
- Returns:
- digested value
- Throws:
- NoSuchAlgorithmException- if the algorithm not found
- Since:
- 2.5.0
- See Also:
 
- 
digestdigest the byte array- Parameters:
- algorithm- the name of the algorithm requested, e.g. MD5, SHA-1, SHA-256, etc.
- Returns:
- digested value
- Throws:
- NoSuchAlgorithmException- if the algorithm not found
- Since:
- 2.5.0
- See Also:
 
 
-