diff options
Diffstat (limited to 'kdejava/koala/org/kde/koala/KCodecs.java')
| -rw-r--r-- | kdejava/koala/org/kde/koala/KCodecs.java | 272 |
1 files changed, 272 insertions, 0 deletions
diff --git a/kdejava/koala/org/kde/koala/KCodecs.java b/kdejava/koala/org/kde/koala/KCodecs.java new file mode 100644 index 00000000..5d266db3 --- /dev/null +++ b/kdejava/koala/org/kde/koala/KCodecs.java @@ -0,0 +1,272 @@ +//Auto-generated by kalyptus. DO NOT EDIT. +package org.kde.koala; + +import org.kde.qt.Qt; +import org.kde.qt.QtSupport; + +/** + + A wrapper class for the most commonly used encoding and + decoding algorithms. Currently there is support for encoding + and decoding input using base64, uu and the quoted-printable + specifications. + <b></b>sage: + <pre> + String input = "Aladdin:open sesame"; + String result = KCodecs.base64Encode(input); + cout << "Result: " << result.data() << endl; + </pre> + <pre> + Output should be + Result: QWxhZGRpbjpvcGVuIHNlc2FtZQ== + </pre> + The above example makes use of the convenience functions + (ones that accept/return null-terminated strings) to encode/decode + a string. If what you need is to encode or decode binary data, then + it is highly recommended that you use the functions that take an input + and output byte[] as arguments. These functions are specifically + tailored for encoding and decoding binary data. + @author Rik Hemsley <rik@kde.org> + + @short A collection of commonly used encoding and decoding algorithms. + +*/ +public class KCodecs implements QtSupport { + private long _qt; + private boolean _allocatedInJavaWorld = true; + protected KCodecs(Class dummy){} + + /** + Encodes the given data using the quoted-printable algorithm. + @param in data to be encoded. + @param useCRLF if true the input data is expected to have + CRLF line breaks and the output will have CRLF line + breaks, too. + @return quoted-printable encoded string. + + @short Encodes the given data using the quoted-printable algorithm. + */ + public static native String quotedPrintableEncode(byte[] in, boolean useCRLF); + public static native String quotedPrintableEncode(byte[] in); + /** + @overload + Same as above except it accepts a null terminated + string instead an array. + @param str string to be encoded. + @param useCRLF if true the input data is expected to have + CRLF line breaks and the output will have CRLF line + breaks, too. + @return quoted-printable encoded string. + + @short @overload + */ + public static native String quotedPrintableEncode(String str, boolean useCRLF); + public static native String quotedPrintableEncode(String str); + /** + Encodes the given data using the quoted-printable algorithm. + Use this function if you want the result of the encoding + to be placed in another array which cuts down the number + of copy operation that have to be performed in the process. + This is also the preferred method for encoding binary data. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be encoded. + @param out encoded data. + @param useCRLF if true the input data is expected to have + CRLF line breaks and the output will have CRLF line + breaks, too. + @short Encodes the given data using the quoted-printable algorithm. + */ + public static native void quotedPrintableEncode(byte[] in, byte[] out, boolean useCRLF); + /** + Decodes a quoted-printable encoded data. + Accepts data with CRLF or standard unix line breaks. + @param in data to be decoded. + @return decoded string. + + @short Decodes a quoted-printable encoded data. + */ + public static native String quotedPrintableDecode(byte[] in); + /** + @overload + Same as above except it accepts a null terminated + string instead an array. + @param str string to be decoded. + @return decoded string. + + @short @overload + */ + public static native String quotedPrintableDecode(String str); + /** + Decodes a quoted-printable encoded data. + Accepts data with CRLF or standard unix line breaks. + Use this function if you want the result of the decoding + to be placed in another array which cuts down the number + of copy operation that have to be performed in the process. + This is also the preferred method for decoding an encoded + binary data. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be decoded. + @param out decoded data. + @short Decodes a quoted-printable encoded data. + */ + public static native void quotedPrintableDecode(byte[] in, byte[] out); + /** + Encodes the given data using the uuencode algorithm. + The output is split into lines starting with the number of + encoded octets in the line and ending with a newline. No + line is longer than 45 octets (60 characters), excluding the + line terminator. + @param in data to be uuencoded + @return uuencoded string. + + @short Encodes the given data using the uuencode algorithm. + */ + public static native String uuencode(byte[] in); + /** + @overload + Same as the above functions except it accepts + a null terminated string instead an array. + @param str string to be uuencoded. + @return encoded string. + + @short @overload + */ + public static native String uuencode(String str); + /** + Encodes the given data using the uuencode algorithm. + Use this function if you want the result of the encoding + to be placed in another array and cut down the number of + copy operation that have to be performed in the process. + This is the preffered method for encoding binary data. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be uuencoded. + @param out uudecoded data. + @short Encodes the given data using the uuencode algorithm. + */ + public static native void uuencode(byte[] in, byte[] out); + /** + Decodes the given data using the uudecode algorithm. + Any 'begin' and 'end' lines like those generated by + the utilities in unix and unix-like OS will be + automatically ignored. + @param in data to be decoded. + @return decoded string. + + @short Decodes the given data using the uudecode algorithm. + */ + public static native String uudecode(byte[] in); + /** + @overload + Same as the above functions except it accepts + a null terminated string instead an array. + @param str string to be decoded. + @return uudecoded string. + + @short @overload + */ + public static native String uudecode(String str); + /** + Decodes the given data using the uudecode algorithm. + Use this function if you want the result of the decoding + to be placed in another array which cuts down the number + of copy operation that have to be performed in the process. + This is the preferred method for decoding binary data. + Any 'begin' and 'end' lines like those generated by + the utilities in unix and unix-like OS will be + automatically ignored. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be decoded. + @param out uudecoded data. + @short Decodes the given data using the uudecode algorithm. + */ + public static native void uudecode(byte[] in, byte[] out); + /** + Encodes the given data using the base64 algorithm. + The booleanean argument determines if the encoded data is + going to be restricted to 76 characters or less per line + as specified by RFC 2045. If <code>insertLFs</code> is true, then + there will be 76 characters or less per line. + @param in data to be encoded. + @param insertLFs limit the number of characters per line. + @return base64 encoded string. + + @short Encodes the given data using the base64 algorithm. + */ + public static native String base64Encode(byte[] in, boolean insertLFs); + public static native String base64Encode(byte[] in); + /** + @overload + Same as the above functions except it accepts + a null terminated string instead an array. + @param str string to be encoded. + @param insertLFs limit the number of characters per line. + @return decoded string. + + @short @overload + */ + public static native String base64Encode(String str, boolean insertLFs); + public static native String base64Encode(String str); + /** + Encodes the given data using the base64 algorithm. + Use this function if you want the result of the encoding + to be placed in another array which cuts down the number + of copy operation that have to be performed in the process. + This is also the preferred method for encoding binary data. + The booleanean argument determines if the encoded data is going + to be restricted to 76 characters or less per line as specified + by RFC 2045. If <code>insertLFs</code> is true, then there will be 76 + characters or less per line. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be encoded. + @param out encoded data. + @param insertLFs limit the number of characters per line. + @short Encodes the given data using the base64 algorithm. + */ + public static native void base64Encode(byte[] in, byte[] out, boolean insertLFs); + public static native void base64Encode(byte[] in, byte[] out); + /** + Decodes the given data that was encoded using the + base64 algorithm. + @param in data to be decoded. + @return decoded string. + + @short Decodes the given data that was encoded using the base64 algorithm. + */ + public static native String base64Decode(byte[] in); + /** + @overload + Same as the above functions except it accepts + a null terminated string instead an array. + @param str string to be decoded. + @return decoded string. + + @short @overload + */ + public static native String base64Decode(String str); + /** + Decodes the given data that was encoded with the base64 + algorithm. + Use this function if you want the result of the decoding + to be placed in another array which cuts down the number + of copy operation that have to be performed in the process. + This is also the preferred method for decoding an encoded + binary data. + NOTE: the output array is first reset and then resized + appropriately before use, hence, all data stored in the + output array will be lost. + @param in data to be decoded. + @param out decoded data. + @short Decodes the given data that was encoded with the base64 algorithm. + */ + public static native void base64Decode(byte[] in, byte[] out); +} |