oracle.ifs.protocols.commands

Class IfsStringListCommand

java.lang.Object

oracle.ifs.protocols.commands.utils.IfsCommand

oracle.ifs.protocols.commands.IfsStringListCommand

All Implemented Interfaces:

Command

public class IfsStringListCommand
extends IfsCommand

An IfsStringListCommand supports string displaying of LibraryObjects' attributes through different format options and attribute naming options.

Inputs:

• los : LibraryObject[] (required)
• session : LibrarySession (required)
• attrNames : String[] (optional)
• buffer : StringBuffer (optional)
• displayAllAttrs : boolean
• namesOnly : boolean

Outputs :

• buffer : StringBuffer

Description:

• Lists as a String LibraryObjects. The form of the listing is based in the inputs to the command. If displayAllAttrs is true then all the available attributes for all the LibraryObjects will be obtained and passed into the AttributeStringListCommand. Otherwise the attribute names passed into the command will be obtained and passed in. If displayAllAttrs and the attrnames passed in are null then no attrinbutes are passed into the command and the command interprupts the names only flag to be either ls (names only is true) or ls -l (name only is false). The actual listing format is changed by changing the AttributeStringListCommand.

Version:

0.9

Author:

Kevin Gillett

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandContextPool	m_AttrDisplayPool
protected CommandContextPool	m_GetAttrNamesPool
protected CommandContextPool	m_GetAttrsPool

Constructor Summary

Constructors

Constructor and Description
IfsStringListCommand() Defualt Constructor

Method Summary

Modifier and Type	Method and Description
CommandContext	createCommandContext() Returns a CommandContext to be used throughout the invocation.
protected void	execute(CommandContext context) Execute a CommandContext.
protected void	execute(StringListContext context) Executes a StringListContext.
protected void	executeAttributeStringDisplay(LibraryObject obj, AttributeValue[] attrs, boolean namesOnly, LibrarySession session, StringBuffer buffer, boolean obfuscate)
protected String[]	executeGetAttributeNames(LibraryObject obj)
protected AttributeValue[]	executeGetAttributes(LibraryObject obj, String[] attrNames)
protected IfsAttributeStringDisplayCommand	getAttributeStringDisplayCommand()
protected IfsGetAttributeNamesCommand	getGetAttributeNamesCommand()
protected IfsGetAttributesCommand	getGetAttributesCommand()
void	populateNestedCommands(CommandInvoker commandInvoker) Populate all the needed nested commands.

Methods inherited from class oracle.ifs.protocols.commands.utils.IfsCommand

postExecute, preExecute, run

Methods inherited from class java.lang.Object

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

Field Detail

m_GetAttrNamesPool

protected CommandContextPool m_GetAttrNamesPool

m_GetAttrsPool

protected CommandContextPool m_GetAttrsPool

m_AttrDisplayPool

protected CommandContextPool m_AttrDisplayPool

Constructor Detail

IfsStringListCommand

public IfsStringListCommand()

Defualt Constructor

(Published)

Method Detail

populateNestedCommands

public void populateNestedCommands(CommandInvoker commandInvoker)
                            throws IfsException

Description copied from class: IfsCommand

Populate all the needed nested commands.

CommandInvoker is not guaranteed to exist for the lifetime of the command. Therefore, the command should not keep a reference to the command invoker and it should acquire all the references to the needed commands in this call-back method.

Specified by:

populateNestedCommands in interface Command

Overrides:

populateNestedCommands in class IfsCommand

Parameters:

commandInvoker - The CommandInvoker object that can be used to acquire references to the needed sub-commands.

Throws:

IfsException - If there is any exception thrown.

See Also:

CommandInvoker

getAttributeStringDisplayCommand

protected IfsAttributeStringDisplayCommand getAttributeStringDisplayCommand()
                                                                     throws IfsException

Throws:

IfsException

getGetAttributesCommand

protected IfsGetAttributesCommand getGetAttributesCommand()
                                                   throws IfsException

Throws:

IfsException

getGetAttributeNamesCommand

protected IfsGetAttributeNamesCommand getGetAttributeNamesCommand()
                                                           throws IfsException

Throws:

IfsException

execute

protected void execute(CommandContext context)
                throws IfsException

Execute a CommandContext.

Overrides:

execute in class IfsCommand

Parameters:

context - the command context.

Throws:

IfsException - if execution fails

(Published)

executeGetAttributeNames

protected String[] executeGetAttributeNames(LibraryObject obj)
                                     throws IfsException

Throws:

IfsException

executeGetAttributes

protected AttributeValue[] executeGetAttributes(LibraryObject obj,
                                                String[] attrNames)
                                         throws IfsException

Throws:

IfsException

executeAttributeStringDisplay

protected void executeAttributeStringDisplay(LibraryObject obj,
                                             AttributeValue[] attrs,
                                             boolean namesOnly,
                                             LibrarySession session,
                                             StringBuffer buffer,
                                             boolean obfuscate)
                                      throws IfsException

Throws:

IfsException

execute

protected void execute(StringListContext context)
                throws IfsException

Executes a StringListContext.

Throws:

IfsException

(Published)

createCommandContext

public CommandContext createCommandContext()
                                    throws IfsException

Returns a CommandContext to be used throughout the invocation.

Specified by:

createCommandContext in interface Command

Overrides:

createCommandContext in class IfsCommand

Returns:

a instance of the CommandContext.

Throws:

IfsException

See Also:

CommandContext

(Published)