org.apache.activemq.console.formatter.OutputFormatter Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.activemq.console.formatter;
import java.io.OutputStream;
import java.util.Collection;
import java.util.Map;
import javax.jms.Message;
import javax.management.AttributeList;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
public interface OutputFormatter {
/**
* Retrieve the output stream being used by the formatter
*/
OutputStream getOutputStream();
/**
* Print an ObjectInstance format of an mbean
* @param mbean - mbean to print
*/
void printMBean(ObjectInstance mbean);
/**
* Print an ObjectName format of an mbean
* @param mbean - mbean to print
*/
void printMBean(ObjectName mbean);
/**
* Print an AttributeList format of an mbean
* @param mbean - mbean to print
*/
void printMBean(AttributeList mbean);
/**
* Print a Map format of an mbean
* @param mbean - mbean to print
*/
@SuppressWarnings("rawtypes")
void printMBean(Map mbean);
/**
* Print a Collection format of mbeans
* @param mbean - collection of mbeans
*/
@SuppressWarnings("rawtypes")
void printMBean(Collection mbean);
/**
* Print a Map format of a JMS message
* @param msg
*/
@SuppressWarnings("rawtypes")
void printMessage(Map msg);
/**
* Print a Message format of a JMS message
* @param msg - JMS message to print
*/
void printMessage(Message msg);
/**
* Print a Collection format of JMS messages
* @param msg - collection of JMS messages
*/
@SuppressWarnings("rawtypes")
void printMessage(Collection msg);
/**
* Print help messages
* @param helpMsgs - help messages to print
*/
void printHelp(String[] helpMsgs);
/**
* Print an information message
* @param info - information message to print
*/
void printInfo(String info);
/**
* Print an exception message
* @param e - exception to print
*/
void printException(Exception e);
/**
* Print a version information
* @param version - version info to print
*/
void printVersion(String version);
/**
* Print a generic key value mapping
* @param map to print
*/
@SuppressWarnings("rawtypes")
void print(Map map);
/**
* Print a generic array of strings
* @param strings - string array to print
*/
void print(String[] strings);
/**
* Print a collection of objects
* @param collection - collection to print
*/
@SuppressWarnings("rawtypes")
void print(Collection collection);
/**
* Print a java string
* @param string - string to print
*/
void print(String string);
}