javax.activation

Class CommandInfo

Contents

  • public class CommandInfo
extends Object
    The CommandInfo class is used by CommandMap implementations to describe the results of command requests. It provides the requestor with both the verb requested, as well as an instance of the bean. There is also a method that will return the name of the class that implements the command but it is not guaranteed to return a valid value. The reason for this is to allow CommandMap implmentations that subclass CommandInfo to provide special behavior. For example a CommandMap could dynamically generate JavaBeans. In this case, it might not be possible to create an object with all the correct state information solely from the class name.
    Since:
    1.6

    • Constructor Detail

      • CommandInfo

        public CommandInfo(String verb,
           String className)
        The Constructor for CommandInfo.
        Parameters:
        verb - The command verb this CommandInfo decribes.
        className - The command's fully qualified class name.

    • Method Detail

      • getCommandName

        public String getCommandName()
        Return the command verb.
        Returns:
        the command verb.

      • getCommandClass

        public String getCommandClass()
        Return the command's class name. This method MAY return null in cases where a CommandMap subclassed CommandInfo for its own purposes. In other words, it might not be possible to create the correct state in the command by merely knowing its class name. DO NOT DEPEND ON THIS METHOD RETURNING A VALID VALUE!
        Returns:
        The class name of the command, or null

      • getCommandObject

        public Object getCommandObject(DataHandler dh,
                      ClassLoader loader)
                        throws IOException,
                               ClassNotFoundException
        Return the instantiated JavaBean component.

        Begin by instantiating the component with Beans.instantiate().

        If the bean implements the javax.activation.CommandObject interface, call its setCommandContext method.

        If the DataHandler parameter is null, then the bean is instantiated with no data. NOTE: this may be useful if for some reason the DataHandler that is passed in throws IOExceptions when this method attempts to access its InputStream. It will allow the caller to retrieve a reference to the bean if it can be instantiated.

        If the bean does NOT implement the CommandObject interface, this method will check if it implements the java.io.Externalizable interface. If it does, the bean's readExternal method will be called if an InputStream can be acquired from the DataHandler.

        Parameters:
        dh - The DataHandler that describes the data to be passed to the command.
        loader - The ClassLoader to be used to instantiate the bean.
        Returns:
        The bean
        Throws:
        IOException
        ClassNotFoundException
        See Also:
        Beans.instantiate(java.lang.ClassLoader, java.lang.String), CommandObject

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/activation/CommandInfo.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut