org.bouncycastle.pkix.util.TextBundle Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bcpkix-jdk14 Show documentation

The Bouncy Castle Java APIs for CMS, PKCS, EAC, TSP, CMP, CRMF, OCSP, and certificate generation. This jar contains APIs for JDK 1.4. The APIs can be used in conjunction with a JCE/JCA provider such as the one provided with the Bouncy Castle Cryptography APIs.

The newest version!

package org.bouncycastle.pkix.util;

import java.io.UnsupportedEncodingException;
import java.util.Locale;
import java.util.TimeZone;

public class TextBundle extends LocalizedMessage 
{

    /**
     * text entry key
     */
    public static final String TEXT_ENTRY = "text";
    
    /**
     * Constructs a new TextBundle using  resource as the base name for the 
     * RessourceBundle and  id as the message bundle id the resource file. 
     * @param resource base name of the resource file 
     * @param id the id of the corresponding bundle in the resource file
     * @throws NullPointerException if  resource or  id is  null
     */
    public TextBundle(String resource, String id) throws NullPointerException 
    {
        super(resource, id);
    }
    
    /**
     * Constructs a new TextBundle using  resource as the base name for the 
     * RessourceBundle and  id as the message bundle id the resource file. 
     * @param resource base name of the resource file 
     * @param id the id of the corresponding bundle in the resource file
     * @param encoding the encoding of the resource file
     * @throws NullPointerException if  resource or  id is  null
     * @throws UnsupportedEncodingException if the encoding is not supported
     */
    public TextBundle(String resource, String id, String encoding) throws NullPointerException, UnsupportedEncodingException 
    {
        super(resource, id, encoding);
    }

    /**
     * Constructs a new TextBundle using  resource as the base name for the 
     * RessourceBundle and  id as the message bundle id the resource file. 
     * @param resource base name of the resource file 
     * @param id the id of the corresponding bundle in the resource file
     * @param arguments an array containing the arguments for the message
     * @throws NullPointerException if  resource or  id is  null
     */
    public TextBundle(String resource, String id, Object[] arguments) throws NullPointerException 
    {
        super(resource, id, arguments);
    }
    
    /**
     * Constructs a new TextBundle using  resource as the base name for the 
     * RessourceBundle and  id as the message bundle id the resource file. 
     * @param resource base name of the resource file 
     * @param id the id of the corresponding bundle in the resource file
     * @param encoding the encoding of the resource file
     * @param arguments an array containing the arguments for the message
     * @throws NullPointerException if  resource or  id is  null
     * @throws UnsupportedEncodingException if the encoding is not supported
     */
    public TextBundle(String resource, String id, String encoding, Object[] arguments) throws NullPointerException, UnsupportedEncodingException 
    {
        super(resource, id, encoding, arguments);
    }
    
    /**
     * Returns the text message in the given locale and timezone.
     * @param loc the {@link Locale}
     * @param timezone the {@link TimeZone}
     * @return the text message.
     * @throws MissingEntryException if the message is not available
     */
    public String getText(Locale loc, TimeZone timezone) throws MissingEntryException
    {
        return getEntry(TEXT_ENTRY,loc,timezone);
    }
    
    /**
     * Returns the text message in the given locale and the defaut timezone.
     * @param loc the {@link Locale}
     * @return the text message.
     * @throws MissingEntryException if the message is not available
     */
    public String getText(Locale loc) throws MissingEntryException
    {
        return getEntry(TEXT_ENTRY,loc,TimeZone.getDefault());
    }

}