Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.crsh.shell.impl.command
Class PipeFilter<C,P>

java.lang.Object
  extended by org.crsh.shell.impl.command.PipeFilter<C,P>
All Implemented Interfaces:
Closeable, Flushable, CommandContext<C>, RuntimeContext, Consumer<C>, Filter<C,P,CommandContext<P>>, Producer<P,CommandContext<P>>, InteractionContext<C>, ScreenContext<C>
Direct Known Subclasses:
PipeFilter.Chunkizer, PipeFilter.Noop, PipeFilter.Sink
abstract class PipeFilter<C,P>
extends Object

    

    
implements Filter<C,P,CommandContext<P>>, CommandContext<C>

    

      

    

  

  

  

    
Author:

    

  

  

  

  

    

      Nested Class Summary
    

    

      (package private) static class
      PipeFilter.Chunkizer

                 		
    

    

      (package private) static class
      PipeFilter.Noop<P>

                 		
    

    

      (package private) static class
      PipeFilter.Sink<P>

                 		
    

  
  
  

    

      Field Summary
    

    

      protected  CommandContext<P>
      context

                .		
    

    

      protected  boolean
      piped

                .		
    

  
  
  

    

      Constructor Summary
    

    

      protected
      PipeFilter(boolean piped)

                 		
    

  
  
  

    

      Method Summary
    

    

       Map<String,Object>
      getAttributes()

                Returns the current attributes.		
    

    

       int
      getHeight()

                Returns the screen height in chars.		
    

    

       String
      getProperty(String propertyName)

                Returns a generic property, usually this property is resolved by the shell client.		
    

    

       Map<String,Object>
      getSession()

                Returns the current session.		
    

    

       int
      getWidth()

                Returns the screen width in chars.		
    

    

       boolean
      isPiped()

                 		
    

    

       String
      readLine(String msg, boolean echo)

                Display a message and read a line on the console.		
    

    

       boolean
      releaseAlternateBuffer()

                Release control of the alternate buffer.		
    

    

       boolean
      takeAlternateBuffer()

                Take control of the alternate buffer.		
    

  
 
  

    

      Methods inherited from class java.lang.Object
    

    

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

  
 
  

    

      Methods inherited from interface org.crsh.io.Producer
    

    

      close, getProducedType, open
    

  
 
  

    

      Methods inherited from interface org.crsh.io.Consumer
    

    

      getConsumedType, provide
    

  
 
  

    

      Methods inherited from interface java.io.Flushable
    

    

      flush
    

  
 
  

  

    

      Field Detail
    

  

  
context

  
protected CommandContext<P> context

  

    

      .
      

      

    

  

  

  
  
piped

  
protected final boolean piped

  

    

      .
      

      

    

  

  

    

      Constructor Detail
    

  

  
PipeFilter

  
protected PipeFilter(boolean piped)

  

  

    

      Method Detail
    

  

  
isPiped

  
public final boolean isPiped()

  

    

      

        
Specified by:

        
isPiped in interface CommandContext<C>

      

    

    

      

    

  

  

  
  
takeAlternateBuffer

  
public final boolean takeAlternateBuffer()
                                  throws IOException

  

    
Description copied from interface: InteractionContext

    

      Take control of the alternate buffer. When the alternate buffer is already used nothing happens. The buffer switch should occur when then Flushable.flush() method is invoked.
      

    

    

      

        
Specified by:

        
takeAlternateBuffer in interface InteractionContext<C>

      

    

    

      

        
Returns:

        
true if the alternate buffer is shown

        
Throws:

        
IOException

      

    

  

  

  
  
releaseAlternateBuffer

  
public final boolean releaseAlternateBuffer()
                                     throws IOException

  

    
Description copied from interface: InteractionContext

    

      Release control of the alternate buffer. When the normal buffer is already used nothing happens. The buffer switch should occur when then Flushable.flush() method is invoked.
      

    

    

      

        
Specified by:

        
releaseAlternateBuffer in interface InteractionContext<C>

      

    

    

      

        
Returns:

        
true if the usual buffer is shown

        
Throws:

        
IOException

      

    

  

  

  
  
getProperty

  
public final String getProperty(String propertyName)

  

    
Description copied from interface: InteractionContext

    

      Returns a generic property, usually this property is resolved by the shell client.
      

    

    

      

        
Specified by:

        
getProperty in interface InteractionContext<C>

      

    

    

      

        
Parameters:

        
propertyName - the property name

        
Returns:

        
the property value

      

    

  

  

  
  
readLine

  
public final String readLine(String msg,
                             boolean echo)

  

    
Description copied from interface: InteractionContext

    

      Display a message and read a line on the console. If no line can be read then null is returned.
      

    

    

      

        
Specified by:

        
readLine in interface InteractionContext<C>

      

    

    

      

        
Parameters:

        
msg - the message to display before reading a line

        
echo - wether or not the line read should be echoed when typing

        
Returns:

        
the line read

      

    

  

  

  
  
getWidth

  
public final int getWidth()

  

    
Description copied from interface: ScreenContext

    

      Returns the screen width in chars. When the value is not positive it means the value could not be determined.
      

    

    

      

        
Specified by:

        
getWidth in interface ScreenContext<C>

      

    

    

      

        
Returns:

        
the term width

      

    

  

  

  
  
getHeight

  
public final int getHeight()

  

    
Description copied from interface: ScreenContext

    

      Returns the screen height in chars. When the value is not positive it means the value could not be determined.
      

    

    

      

        
Specified by:

        
getHeight in interface ScreenContext<C>

      

    

    

      

        
Returns:

        
the term height

      

    

  

  

  
  
getSession

  
public Map<String,Object> getSession()

  

    
Description copied from interface: RuntimeContext

    

      Returns the current session.
      

    

    

      

        
Specified by:

        
getSession in interface RuntimeContext

      

    

    

      

        
Returns:

        
the session map

      

    

  

  

  
  
getAttributes

  
public Map<String,Object> getAttributes()

  

    
Description copied from interface: RuntimeContext

    

      Returns the current attributes.
      

    

    

      

        
Specified by:

        
getAttributes in interface RuntimeContext

      

    

    

      

        
Returns:

        
the attributes map

      

    

  

  

   
  

    

      
        
        

          

            Overview 
            Package 
             Class 
            Use 
            Tree 
            Deprecated 
            Index 
            Help 
          

        

      		
      
    

    

       PREV CLASS   NEXT CLASS
      FRAMES    NO FRAMES     
       
    

    

      SUMMARY: NESTED | FIELD | CONSTR | METHOD
      DETAIL: FIELD | CONSTR | METHOD
    

  

  

  Copyright © 2014 eXo Platform SAS. All Rights Reserved.