buildframework/helium/sf/java/core/src/com/nokia/helium/core/plexus/FileStreamConsumer.java
author wbernard
Fri, 13 Aug 2010 14:59:05 +0300
changeset 628 7c4a911dc066
parent 587 85df38eb4012
permissions -rw-r--r--
helium_11.0.0-e00f171ca185
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     1
/*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     2
* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     3
* All rights reserved.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     4
* This component and the accompanying materials are made available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     6
* which accompanies this distribution, and is available
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     8
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
     9
* Initial Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    11
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    12
* Contributors:
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    13
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    14
* Description:  
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    15
*
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    16
*/
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    17
package com.nokia.helium.core.plexus;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    18
628
7c4a911dc066 helium_11.0.0-e00f171ca185
wbernard
parents: 587
diff changeset
    19
import java.io.BufferedWriter;
587
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    20
import java.io.File;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    21
import java.io.FileNotFoundException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    22
import java.io.FileOutputStream;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    23
import java.io.IOException;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    24
import java.io.OutputStreamWriter;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    25
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    26
import org.apache.log4j.Logger;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    27
import org.codehaus.plexus.util.cli.StreamConsumer;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    28
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    29
/**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    30
 * Record a stream into a file. 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    31
 *
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    32
 */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    33
public class FileStreamConsumer implements StreamConsumer {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    34
    private Logger log = Logger.getLogger(getClass());
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    35
    private BufferedWriter writer;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    36
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    37
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    38
     * Create a FileStreamConsumer which will record content to 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    39
     * the output file.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    40
     * @param output the file to write the output to.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    41
     * @throws FileNotFoundException if an error occur while opening the file.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    42
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    43
    public FileStreamConsumer(File output) throws FileNotFoundException {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    44
        writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(output)));
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    45
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    46
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    47
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    48
     * {@inheritDoc}
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    49
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    50
    @Override
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    51
    public synchronized void consumeLine(String line) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    52
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    53
            writer.write(line);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    54
            writer.newLine();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    55
        } catch (IOException e) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    56
            log.error("Error while writing to file: " + e.getMessage(), e);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    57
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    58
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    59
    
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    60
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    61
     * Closing the file.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    62
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    63
    public void close() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    64
        try {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    65
            writer.flush();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    66
            writer.close();
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    67
        } catch (IOException e) {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    68
            log.error("Error while writing to file: " + e.getMessage(), e);
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    69
        }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    70
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    71
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    72
    /**
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    73
     * Helper function to return the writer instance for sub classes
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    74
     * to write if any additional information.
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    75
     * @return writer of the stream consumer. 
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    76
     */
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    77
    public BufferedWriter getWriter() {
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    78
        return writer;
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    79
    }
85df38eb4012 helium_9.0-a7879c935424
wbernard
parents:
diff changeset
    80
}