diff options
author | Vincent Breitmoser <valodim@mugenguild.com> | 2014-06-05 14:06:07 +0200 |
---|---|---|
committer | Vincent Breitmoser <valodim@mugenguild.com> | 2014-06-05 14:17:49 +0200 |
commit | c84a1ecfff8d3f21ac83ef7b041f22f11e38936b (patch) | |
tree | f56d6f777689c9dc7df364e253663ae436197cac /OpenKeychain/src/main/java/org/sufficientlysecure/keychain | |
parent | 5ab0d76c696512ea0830f178df17bb23c38e9e6c (diff) | |
download | open-keychain-c84a1ecfff8d3f21ac83ef7b041f22f11e38936b.tar.gz open-keychain-c84a1ecfff8d3f21ac83ef7b041f22f11e38936b.tar.bz2 open-keychain-c84a1ecfff8d3f21ac83ef7b041f22f11e38936b.zip |
import-log: add parcelable prototype
Diffstat (limited to 'OpenKeychain/src/main/java/org/sufficientlysecure/keychain')
-rw-r--r-- | OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/OperationResultParcel.java | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/OperationResultParcel.java b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/OperationResultParcel.java new file mode 100644 index 000000000..497c3dd71 --- /dev/null +++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/OperationResultParcel.java @@ -0,0 +1,123 @@ +package org.sufficientlysecure.keychain.pgp; + +import android.R; +import android.os.Parcel; +import android.os.Parcelable; + +import java.util.ArrayList; + +/** Represent the result of an operation. + * + * This class holds a result and the log of an operation. It can be subclassed + * to include typed additional information specific to the operation. To keep + * the class structure (somewhat) simple, this class contains an exhaustive + * list (ie, enum) of all possible log types, which should in all cases be tied + * to string resource ids. + * + */ +public class OperationResultParcel implements Parcelable { + /** Holds the overall result. A value of 0 is considered a success, all + * other values may represent failure or varying degrees of success. */ + final int mResult; + + /// A list of log entries tied to the operation result. + final ArrayList<LogEntryParcel> mLog; + + public OperationResultParcel(int result, ArrayList<LogEntryParcel> log) { + mResult = result; + mLog = log; + } + + public OperationResultParcel(Parcel source) { + mResult = source.readInt(); + mLog = source.createTypedArrayList(LogEntryParcel.CREATOR); + } + + public boolean isSuccessful() { + return mResult == 0; + } + + /** One entry in the log. */ + public static class LogEntryParcel implements Parcelable { + final LogType mType; + final LogLevel mLevel; + final String[] mParameters; + + public LogEntryParcel(LogType type, LogLevel level, String[] parameters) { + mType = type; + mLevel = level; + mParameters = parameters; + } + + public LogEntryParcel(Parcel source) { + mType = LogType.values()[source.readInt()]; + mLevel = LogLevel.values()[source.readInt()]; + mParameters = source.createStringArray(); + } + + @Override + public int describeContents() { + return 0; + } + + @Override + public void writeToParcel(Parcel dest, int flags) { + dest.writeInt(mType.ordinal()); + dest.writeInt(mLevel.ordinal()); + dest.writeStringArray(mParameters); + } + + public static final Creator<LogEntryParcel> CREATOR = new Creator<LogEntryParcel>() { + public LogEntryParcel createFromParcel(final Parcel source) { + return new LogEntryParcel(source); + } + + public LogEntryParcel[] newArray(final int size) { + return new LogEntryParcel[size]; + } + }; + + } + + public static enum LogType { + // TODO add actual log entry types here + MSG_IMPORT_OK (R.string.copy), + MSG_IMPORT_FAILED (R.string.cancel); + + private int mMsgId; + LogType(int msgId) { + mMsgId = msgId; + } + } + + /** Enumeration of possible log levels. */ + public static enum LogLevel { + DEBUG, + INFO, + WARN, + /** If any ERROR log entry is included in the result, the overall operation should have failed. */ + ERROR, + } + + @Override + public int describeContents() { + return 0; + } + + @Override + public void writeToParcel(Parcel dest, int flags) { + dest.writeInt(mResult); + dest.writeTypedList(mLog); + } + + public static final Creator<OperationResultParcel> CREATOR = new Creator<OperationResultParcel>() { + public OperationResultParcel createFromParcel(final Parcel source) { + return new OperationResultParcel(source); + } + + public OperationResultParcel[] newArray(final int size) { + return new OperationResultParcel[size]; + } + }; + +} |