CoreMessageKey.java

/*
 *
 *  Copyright 2014 http://Bither.net
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 * /
 */

package net.bither.core;

/**
 * <p>Enum to provide the following to application:</p>
 * <ul>
 * <li>Message keys to use for internationalisation of output from the core module</li>
 * </ul>
 * <p/>
 * <h3>Naming conventions</h3>
 * <p>Message keys are placed in an enum for type safety.</p>
 * <p>Message keys have their resource key so that IDEs can maintain a "where used" reference lookup.</p>
 * <p>Message keys are never concatenated to form larger sentences. Instead use token replacements
 * within a larger sentence structure.</p>
 * <p>Resource keys are simply the message key enum name prefixed with "core_" in lower case.</p>
 *
 * @since 0.0.1
 */
public enum CoreMessageKey {

    // Core messages
    NOT_INITIALISED("core_not_initialised"),
    START_NETWORK_CONNECTION_ERROR("core_start_network_connection_error"),
    CHAIN_DOWNLOAD("core_chain_download"),
    PEER_COUNT("core_peer_count"),

    // Sending bitcoin
    TRANSACTION_CREATED_OK("core_transaction_created_ok"),
    TRANSACTION_CREATION_FAILED("core_transaction_creation_failed"),

    // Not used
    @Deprecated
    SENDING_BITCOIN("core_sending_bitcoin"),

    BITCOIN_SENT_OK("core_bitcoin_sent_ok"),
    BITCOIN_SEND_FAILED("core_bitcoin_send_failed"),

    // Security
    DEBUGGER_ATTACHED("core_debugger_attached"),
    SYSTEM_TIME_DRIFT("core_system_time_drift"),
    BACKUP_FAILED("core_backup_failed"),
    CERTIFICATE_FAILED("core_certificate_failed"),
    SECURITY_ADVICE("core_security_advice"),
    BACKUP_WALLET_WAS_LOADED("core_backup_wallet_was_loaded"),

    // Errors
    THE_ERROR_WAS("core_the_error_was"),
    COULD_NOT_CONNECT_TO_BITCOIN_NETWORK("core_could_not_connect_to_bitcoin_network"),
    NO_ACTIVE_WALLET("core_no_active_wallet"),

    // Transaction/Payment adaption
    PAYMENT_REQUESTED("core_payment_requested"),
    PAYMENT_RECEIVED("core_payment_received"),
    PAYMENT_RECEIVING("core_payment_receiving"),
    PAYMENT_SENT("core_payment_sent"),
    PAYMENT_SENDING("core_payment_sending"),
    PAYMENT_PAID("core_payment_paid"),
    PAYMENT_PART_PAID("core_payment_part_paid"),
    CONFIRMED_BY_ONE_BLOCK("core_confirmed_by_one_block"),
    CONFIRMED_BY_SEVERAL_BLOCKS("core_confirmed_by_several_blocks"),
    BROADCAST("core_broadcast"),
    NOT_BROADCAST("core_not_broadcast"),
    DEAD("core_dead"),
    UNKNOWN("core_unknown"),
    NO_PAYMENT_REQUEST("core_no_payment_request"),

    // These appear to be not used
    @Deprecated
    TRANSACTION_TO("core_transaction_to"),
    @Deprecated
    TRANSACTION_BY("core_transaction_by"),

    // Exchange messages
    EXCHANGE_OK("core_exchange_ok"),
    EXCHANGE_ERROR("core_exchange_error"),
    EXCHANGE_DOWN("core_exchange_down"),

    // Not used
    @Deprecated
    CHANGE_PASSWORD_REPORT_TITLE("core_change_password_report_title"),

    CHANGE_PASSWORD_WORKING("core_change_password_working"),
    CHANGE_PASSWORD_SUCCESS("core_change_password_success"),
    CHANGE_PASSWORD_WRONG_OLD_PASSWORD("core_change_password_wrong_old_password"),
    CHANGE_PASSWORD_ERROR("core_change_password_error"),

    SIGN_MESSAGE_ENTER_ADDRESS("core_sign_message_enter_address"),
    SIGN_MESSAGE_ENTER_MESSAGE("core_sign_message_enter_message"),
    SIGN_MESSAGE_ENTER_PASSWORD("core_sign_message_enter_password"),
    SIGN_MESSAGE_SUCCESS("core_sign_message_success"),
    SIGN_MESSAGE_NO_SIGNING_KEY("core_sign_message_no_signing_key"),
    SIGN_MESSAGE_SIGNING_KEY_NOT_ENCRYPTED("core_sign_message_signing_key_not_encrypted"),
    SIGN_MESSAGE_NO_WALLET("core_sign_message_no_wallet"),
    SIGN_MESSAGE_NO_PASSWORD("core_sign_message_no_password"),
    SIGN_MESSAGE_FAILURE("core_sign_message_failure"),

    VERIFY_MESSAGE_ENTER_ADDRESS("core_verify_message_enter_address"),
    VERIFY_MESSAGE_ENTER_MESSAGE("core_verify_message_enter_message"),
    VERIFY_MESSAGE_ENTER_SIGNATURE("core_verify_message_enter_signature"),
    VERIFY_MESSAGE_FAILURE("core_verify_message_failure"),
    VERIFY_MESSAGE_VERIFY_SUCCESS("core_verify_message_verify_success"),
    VERIFY_MESSAGE_VERIFY_FAILURE("core_verify_message_verify_failure"),

    WALLET_CAPABILITIES("core_wallet_capabilities"),
    WALLET_CAPABILITY_MBHD_SOFT("core_wallet_capability_mbhd_soft"),


    // End of enum
    ;

    private final String key;

    private CoreMessageKey(String key) {
        this.key = key;
    }

    /**
     * @return The key for use with the resource bundles
     */

    public String getKey() {
        return key;
    }

}