Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache » activemq » console » formatter » [javadoc | source]
    1   /**
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements.  See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache License, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License.  You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
   10    *
   11    * Unless required by applicable law or agreed to in writing, software
   12    * distributed under the License is distributed on an "AS IS" BASIS,
   13    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   14    * See the License for the specific language governing permissions and
   15    * limitations under the License.
   16    */
   17   package org.apache.activemq.console.formatter;
   18   
   19   import java.io.OutputStream;
   20   import java.util.Collection;
   21   import java.util.Map;
   22   
   23   import javax.jms.Message;
   24   import javax.management.AttributeList;
   25   import javax.management.ObjectInstance;
   26   import javax.management.ObjectName;
   27   
   28   public interface OutputFormatter {
   29   
   30       /**
   31        * Retrieve the output stream being used by the formatter
   32        * @return
   33        */
   34       OutputStream getOutputStream();
   35   
   36       /**
   37        * Print an ObjectInstance format of an mbean
   38        * @param mbean - mbean to print
   39        */
   40       void printMBean(ObjectInstance mbean);
   41   
   42       /**
   43        * Print an ObjectName format of an mbean
   44        * @param mbean - mbean to print
   45        */
   46       void printMBean(ObjectName mbean);
   47   
   48       /**
   49        * Print an AttributeList format of an mbean
   50        * @param mbean - mbean to print
   51        */
   52       void printMBean(AttributeList mbean);
   53   
   54       /**
   55        * Print a Map format of an mbean
   56        * @param mbean - mbean to print
   57        */
   58       void printMBean(Map mbean);
   59   
   60       /**
   61        * Print a Collection format of mbeans
   62        * @param mbean - collection of mbeans
   63        */
   64       void printMBean(Collection mbean);
   65   
   66       /**
   67        * Print a Map format of a JMS message
   68        * @param msg
   69        */
   70       void printMessage(Map msg);
   71   
   72       /**
   73        * Print a Message format of a JMS message
   74        * @param msg - JMS message to print
   75        */
   76       void printMessage(Message msg);
   77   
   78       /**
   79        * Print a Collection format of JMS messages
   80        * @param msg - collection of JMS messages
   81        */
   82       void printMessage(Collection msg);
   83   
   84       /**
   85        * Print help messages
   86        * @param helpMsgs - help messages to print
   87        */
   88       void printHelp(String[] helpMsgs);
   89   
   90       /**
   91        * Print an information message
   92        * @param info - information message to print
   93        */
   94       void printInfo(String info);
   95   
   96       /**
   97        * Print an exception message
   98        * @param e - exception to print
   99        */
  100       void printException(Exception e);
  101   
  102       /**
  103        * Print a version information
  104        * @param version - version info to print
  105        */
  106       void printVersion(String version);
  107   
  108       /**
  109        * Print a generic key value mapping
  110        * @param map to print
  111        */
  112       void print(Map map);
  113   
  114       /**
  115        * Print a generic array of strings
  116        * @param strings - string array to print
  117        */
  118       void print(String[] strings);
  119   
  120       /**
  121        * Print a collection of objects
  122        * @param collection - collection to print
  123        */
  124       void print(Collection collection);
  125   
  126       /**
  127        * Print a java string
  128        * @param string - string to print
  129        */
  130       void print(String string);
  131   }

Save This Page
Home » activemq-parent-5.3.1-source-release » org.apache » activemq » console » formatter » [javadoc | source]