Opus+ Version 1.0 Java API

opusplus.core.lilypond
Class LilypondWriter

java.lang.Object
  extended by opusplus.core.lilypond.LilypondWriter

public class LilypondWriter
extends java.lang.Object

    

This class uses a stave iterator to visit every element within the composition and writes it out in Lilypond format.

Author:
Adrian Marriott

Constructor Summary
LilypondWriter()
          Default ctor that uses the working directory and the Lilypond output file name specified in the system parameters.
LilypondWriter(java.io.File lyFile)
          Convenience ctor to output to a particular file.
LilypondWriter(java.io.PrintStream out)
          Ctor to write Lilypond data out to any print stream - for example the console.
 
Method Summary
 java.util.ArrayList execute()
          Operates the Lilypond writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LilypondWriter

public LilypondWriter(java.io.File lyFile)
Convenience ctor to output to a particular file.


LilypondWriter

public LilypondWriter(java.io.PrintStream out)
Ctor to write Lilypond data out to any print stream - for example the console.


LilypondWriter

public LilypondWriter()
Default ctor that uses the working directory and the Lilypond output file name specified in the system parameters. If the working directory is not discovered on this system then a new one is created in the current working directory.

Method Detail

execute

public java.util.ArrayList execute()
Operates the Lilypond writer. Returns a list of java.io.File objects representing the Lilypond files generated, or null processing failed. If constructed with a PrintStream object directly null is always returned.


Opus+ Version 1.0 Java API

Copyright © 2005-2010 Adrian Marriott.
All Rights Reserved.