org.apache.karaf.shell.commands.impl

Class WcAction

java.lang.Object

org.apache.karaf.shell.commands.impl.WcAction

All Implemented Interfaces:

org.apache.karaf.shell.api.action.Action

public class WcAction
extends Object
implements org.apache.karaf.shell.api.action.Action

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	WcAction.WordCounts Represent a basic object to store the word count data.

Constructor Summary

Constructors

Constructor and Description
WcAction()

Method Summary

Modifier and Type	Method and Description
Object	execute()
protected String	formatWordCounts(WcAction.WordCounts wordCounts, String reportName) Create a human readable format of the given count information.
protected String	getFilesWordCountReport(List<File> files) Create a combined word count report of the required files.
protected WcAction.WordCounts	getWordCounts(InputStream inputStream) Perform the main logic of counting the relevant data within a given input stream.
protected void	setDefaultOptions() Set the default options for this action if none have been supplied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WcAction

public WcAction()

Method Detail

execute

public Object execute()
               throws Exception

Specified by:

execute in interface org.apache.karaf.shell.api.action.Action

Throws:

Exception

getFilesWordCountReport

protected String getFilesWordCountReport(List<File> files)
                                  throws IOException

Create a combined word count report of the required files. If there are more than one file supplied, a total row will be added.

Parameters:

files - the list of files.

Returns:

the word count report String.

Throws:

IOException - in case of a count failure.

setDefaultOptions

protected void setDefaultOptions()

Set the default options for this action if none have been supplied.

getWordCounts

protected WcAction.WordCounts getWordCounts(InputStream inputStream)
                                     throws IOException

Perform the main logic of counting the relevant data within a given input stream.

Note, a line is considered to be terminated by linefeed '\n' or carriage return '\r'. A previous linefeed will be consumed.

This method assumes UTF-8.

Parameters:

inputStream - the input stream.

Returns:

the word count result.

Throws:

IOException - in case of word count failure.

formatWordCounts

protected String formatWordCounts(WcAction.WordCounts wordCounts,
                                  String reportName)

Create a human readable format of the given count information.

Parameters:

wordCounts - the word count object containing the information.

reportName - the name associated with the word counts, ie a file name.

Returns:

a human readable String representing the word count information.