TweetFollow Us on Twitter

Combining Two Faces OF OS X: AppleScript and Java

Volume Number: 21 (2005)
Issue Number: 4
Column Tag: Programming

Combining Two Faces OF OS X: AppleScript and Java

by David Miller

Bridging the Gap

Roll Your Own Solution


With the announcement and previews of the new version of Apple's operating system, Tiger, Mac users are starting to get excited about its new features. End users are looking forward to the conveniences brought on by features such as Spotlight and Dashboard, while developers are salivating over frameworks bundled with Tiger such as Core Data and Core Image. And while each new version of OS X has introduced enhancements that are compelling enough to convince users and developers to upgrade, a few ragged edges have also found their way into the foundation.

Two of OS X's highly-touted features are its excellent Java support, and the ease with which automated workflows are created via AppleScript. This article will focus on one of the ragged edges between these two components.

Part 1: AppleScript

AppleScript has been a part of the Mac OS since System 7, and not surprisingly, has had its share of ups and downs since its debut; the transition from OS 9 to OS X was particularly rough on it. Scripts running in the early versions of OS X often had to interact with applications nestled within both the Aqua and the "Classic" emulation layers; while this solution was not a huge obstacle for scripters, it was by no means an elegant solution.

To make matters worse, early versions of Carbon and Cocoa applications often included shoddy AppleScript support due to the amount of effort required to make the jump from OS 9 to OS X. In fact, this situation is just as relevant as it ever was, as developers are understandably more concerned about getting their applications to take advantage of OS X's newest features than to prolong the development cycle to include a "bonus" such as AppleScript support. Frameworks such as Rendezvous, WebKit, and Cocoa Bindings have allowed developers to provide more bang for their applications' buck, yet AppleScript often seems to be left behind. iTunes was an excellent example of this situation, as it did not receive substantial AppleScript support until version 3, (and many of Apple's staple applications such as Safari still don't play nicely with AppleScript).

Yet, ironically enough, OS X has become a bigger and better playground for scripters with each successive release:

  • the Script Menu item has effectively replaced the Script Runner application, and has brought with it the ability to execute scripts written in a variety of flavors besides AppleScript (Perl, Python, and a variety of shell flavors: bash, zsh, tcsh, etc.);
  • the addition of AppleScript Studio to OS X's developer tools has allowed scripters to create full-fledged Cocoa applications with AppleScript and Aqua's native widget set and, in doing so, introduced improvements to the language and AppleEvent model;
  • And Tiger will introduce Automator, an application and framework that will make scripting almost as simple as point-and-click.

AppleScript Studio, as mentioned above, was built upon an Objective-C--AppleScript bridge that allows scripts access to the methods and properties of Cocoa objects. However, this wasn't the first instance of Cocoa applications being written in a language other than Objective-C.

Part 2: Java

One of OS X's major selling points is its tight coupling with Java; heavy-weight tools such as the JBoss J2EE application server and Apache Tomcat can be installed and running on a Mac with a minimal amount of configuration. However, OS X's Java support doesn't end at the command-line. While Cocoa's "native" language is Objective-C, Cocoa's foundation classes have also been ported to Java which, in theory, gives developers the choice between two object-oriented languages for their Cocoa applications.

The above statement is qualified with "in theory" because while it is entirely possible to build a Cocoa application with Java, it is by no means a common occurrence. Cocoa's ancestor, with which it still shares many traits (including the NS prefix for class names) was created for Objective-C's object model within the NextStep environment, and then retro-fitted onto the Java object model for the release of OS X. Creating the Java-Cocoa classes was a nice gesture on Apple's part, but developers have chosen to forego Java and learn Objective-C for Cocoa hacking for several reasons:

  • The Cocoa Java classes are treated as second-class citizens when compared to their Objective-C counterparts, both in terms of their development and documentation,
  • And building Cocoa applications with Objective-C is much like placing a round peg in its round hole, whereas building them with Java is akin to forcing the round peg into a square hole.

And because the square hole seems to be an afterthought, it often gets overlooked when it comes time for framework releases and updates; it is no secret that the documentation and implementation for the Cocoa-Java classes is lacking; frameworks such as the Address Book have become widely accepted in Objective-C applications yet still have no Java hooks. Take for instance, the NSAppleScript class, which is used in the following (simplified) Java class:

Listing 1:

A simple Java class that makes use of NSFoundation's classes for interacting with AppleScript.


public class NextTrack {

  public static void main(String[] args) {
    String script = "tell application \"iTunes\"\n"
      + " next track \nend tell";
    NSAppleScript myScript =  new NSAppleScript(script);
    NSMutableDictionary errors= new NSMutableDictionary();
    NSAppleEventDescriptor results =

The above code should accomplish the same result when run through OS X's Java interpreter as the following snippet of AppleScript when run in Script Editor:

Listing 2: NextTrack.scpt

A simple script that will tell iTunes to start playing the next track.

tell application "iTunes"
   next track
end tell

...and the following Objective-C method when invoked by another class:

Listing 3: NextTrack.m

The Objective-C equivalent to the Java code in Listing 1, and the AppleScript shown in Listing 2:

- (void) play
   NSAppleScript *play =
      [[NSAppleScript alloc]
   @"tell application \"iTunes\"\n next track\n end tell"];
   [play executeAndReturnError:nil];

And not surprisingly, the native AppleScript and Objective-C versions shown in Listings 2 and 3 execute precisely as expected; now let's see how the Java version fairs. Compiling the Java code can be accomplished through the following command in Terminal:

javac -classpath .:/System/Library/Java/

... and subsequently executed with...

java -classpath .:/System/Library/Java/ AppleScriptTest

We would expect that the next song in our iTunes playlist would begin playing after executing the above command. However, once the shell gives control to the Java interpreter to execute our program, things go downhill -- the program hangs as soon as the NSAppleScript's execute method is invoked. And even worse, the AppleScript is never executed, which leaves leaving Java developers who wish to incorporate AppleScript into their programs in a bind.

But all is not lost; Thanks to OS X's command-line interface and its osascript utility, it is possible to make a home-made solution to pass information from AppleScript to Java. Traditionally this would process would be done by using an instance of the NSAppleEventDescription class, yet we have seen that this will not work in Java. Let's see how we can overcome this bug in OS X.

Rolling Your Own Solution

Our homegrown solution has two requirements: (1) that we can execute AppleScripts from within Java's sandbox, and (2) that we are able to send the result of a script back to the sandbox. Luckily, both steps can be taken care of by the osascript command.

Included in OS X since its initial release, the osascript command executes AppleScripts in the same way that scripts from traditional languages (such as Perl, Python, and Bash) are executed: through the shell. In terms of the shell, the main difference between executing shell scripts and AppleScripts is that the former can be made executable through the use of UNIX permissions and the she-bang line (the first line of a script, which indicates which program should be interpret the script), while the osascript program must interpret AppleScripts. However, osascript follows the same rules as every other UNIX utility, namely:

  • The program will return 0 to the shell if the AppleScript was executed successfully, or 1 if the script execution terminated abnormally,
  • And the script's result will be echoed to one of stdout or stderr, depending on the return value mentioned above.

And like most other UNIX commands, all you need to know about osascript can be found out through its man page by typing man osascript. For now, all we need to know is that the command osascript test.appleScript will attempt to execute the file test.appleScript in the exact same way as though the script was executed in one of the "traditional" methods, such as through the Script Menu or executing it from within Script Editor.

The Solution, Part 1: Executing AppleScript From Java

Thus, it is relatively trivial to write a wrapper for the osascript program that will capture the script's result and store it in a String; the code shown in Listing 5 does just that.

Listing 5:

We can use the osascript command to run an AppleScript file via the shell. The output of the script will be echoed to standard out if successful, or sent to standard error if not. Either way, it can be trapped by using an InputStream and then inspected as required.

public String run(File script) throws AppleScriptException,
   java.lang.InterruptedException {

ArrayList cmd = new ArrayList(); 

// add necessary command-line switches here...

// create an array to store the parameters
String[] cmdArray = (String[]) cmd.toArray(new String[0]);

// run the script
Process result = Runtime.getRuntime().exec(cmdArray);

String line;
StringBuffer output = new StringBuffer();

/* if something bad happened while trying to run the script, throw an AppleScriptException 
   letting the user know what the problem was */
if (result.exitValue() != 0) {
  // read in the description of the error
   BufferedReader err = new BufferedReader(new
   while ((line = err.readLine()) != null) {
       output.append(line + "\n");
   // and throw an exception describing what the problem was throw new 
// otherwise the script ran successfully
} else {

   /* read in the output */
   BufferedReader out = new BufferedReader(new
   while ((line = out.readLine()) != null) {
      output.append(line + "\n");

The Solution, Part 2: Returning AppleScript Results to Java

Now you may be asking yourself, "What is the result of an AppleScript?" A script's result is defined to be the value of the last statement in the script. For example, the result of the following script will be a reference to the track that is currently playing iTunes:

Listing 4: GetCurrentTrack.scpt


A simple AppleScript used to retrieve the current track in iTunes.

tell application "iTunes"
   set mytrack to current track
end tell

If executed through Script Editor, the result of the above script will be an instance of iTunes' Track class, which contains all of the information retained by iTunes (such as its artist, album, rating, etc.) for the track that is currently playing. However, if the above script is executed through the osascript command after saving it to a file, the following result will be echoed back to the Terminal:

Listing 4: Sample Result

The result of converting an AppleScript object to a textual representation.

"class cFlT" id 105

The two listings included above are merely different representations of the same result. Listing 4 is the result of converting an AppleScript object to text for echoing to the shell; and in the process of converting the object all information about the track that we were hoping to use in our Java program is lost. However, there is a way around this problem: by changing our script so that its result can be parsed as text, we can then capture that information without changing our Java code.

For example, we can retrieve the information for the currently playing track in iTunes and echo it to the shell by passing the following file to osascript :

Listing 5:GetCurrentTrack.scpt


The following script will result in the information for the current track being echoed out to standard out with the fields delimited by a tab character (\t).

set tab to "\t"
tell application "iTunes"
      set r to current track
      set myvalue to (album of r & tab & artist of r & tab & bit rate of r & 
         tab & comment of r & tab & compilation of r & tab & composer of r & tab & 
         database ID of r & tab & (date added of r as string) & tab & disc count 
         of r & tab & disc number of r & tab & duration of r & tab & enabled of r 
         & tab & (EQ of r as string) & tab & (genre of r as string) & tab & (kind of 
         r as string) & tab & (modification date of r as string) & tab & played 
         count of r & tab & (played date of r as string) & tab & rating of r & tab & 
         sample rate of r & tab & size of r & tab & track count of r & tab & track 
         number of r & tab & year of r & tab & name of r)
   on error
      (* do nothing *)
   end try
end tell

As can be seen from the listing, the script will return the fields of the current track in a tab-delimited format. The Java wrapper method will store this information as a String, which can then be parsed to extract the relevant fields of the Track that we are looking for. The following code illustrates how to do exactly that:

Listing 6:


The following method will return an object containing all of the information for the track that is currently playing in iTunes. After the tab-delimited result is stored, it is broken up into its individual fields, which are used to set the fields of the Track instance. The Calendar.parseAppleScriptDate method is used to convert a textual representation of an AppleScript date field to a java.util.Date object; and numbers must be parsed as Integers before setting our track's attributes.

public static Track getCurrentTrack() throws AppleScriptException {

   try {
      File script = new File();

      // <snip>
      // store a get a reference to a file containing the
    // AppleScript shown in Listing 5
      // </snip>

      AppleScript as = new AppleScript(script);
      String result =;

      // split the output on the tab character (\t) to 
      // break it into the individual fields
      String[] bits = result.split("\t");
      // if we only have one item, then no track was returned
      if (bits.length <= 1) {
         throw new AppleScriptException("No current track");

      // the object used to store all of the info
      Track current = new Track();
      // loop through all fields and set the corresponding
      // attributes of the Track object...
         new Boolean(bits[4]).booleanValue());

      // <snip>other modifiers go here</snip>


      return current;

   // if the script doesn't execute properly, then throw
   // an exception to propagate the error
   } catch (Exception e) {
      throw new AppleScriptException(e);

It should be noted that our solution does require more code than would be required if Apple's NS* Java classes worked as intended. But, oddly enough, the extra code is AppleScript, not Java, due to the process of manually flattening AppleScript objects into a single string rather than using an NSAppleEventDescriptor to contain the object's individual fields. While it is by no means an elegant solution, it gets the job done reliably and proves to be an interesting exercise in making the different faces of OS X talk to each other in ways that weren't originally intended.

Wrapping Up

Mac OS X has proven to be a healthy and productive platform for developers, and given Apple's recent track record there are no signs that this situation will change in the near future. However, with all of the new technical demos shown in Tiger's previews intended for Objective-C, one hopes that Java developers will also have something to play with upon booting up Apple's new operating system. Or, if not something new, then at least a working copy of what was promised years ago when the first version of OS X was being previewed to developers years ago.

About the Code

The class and supporting JAR files can be found on the CD, which also includes an ANT build file to take care of the heavy lifting; see the accompanying documentation for more information on how to build the class. There are several classes used in the above listing that are free to download and use:

  • and are part of the package,
  • And is part of the com.fivevoltlogic.mytunes package.

Copies are included on the CD and can also be downloaded from

David Miller is a developer based in Calgary, AB, Canada. You can reach him by sending an email to or pointing your browser to


Community Search:
MacTech Search:

Software Updates via MacUpdate

MacPilot 8.0 - Enable over 1,200 hidden...
MacPilot gives you the power of UNIX and the simplicity of Macintosh, which means a phenomenal amount of untapped power in your hands! Use MacPilot to unlock over 1,200 features, and access them all... Read more
Typinator 6.7 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
Adobe Lightroom 6.2 - Import, develop, a...
Adobe Lightroom is available as part of Adobe Creative Cloud for as little as $9.99/month bundled with Photoshop CC as part of the photography package. Lightroom 6 is also available for purchase as a... Read more
ForeverSave 2.1.4 - Universal auto-save...
ForeverSave auto-saves all documents you're working on while simultaneously doing backup versioning in the background. Lost data can be quickly restored at any time. Losing data, caused by... Read more
VueScan 9.5.27 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
AirPort Utility 6.3.6 - Set up and manag...
Note: Most recent release available only within OS X 10.11 El Capitan update. Use AirPort Utility to set up and manage your Wi-Fi network and AirPort base stations, including AirPort Express, AirPort... Read more
Quicksilver 1.3.1 - Application launcher...
Quicksilver is a light, fast and free Mac application that gives you the power to control your Mac with keystrokes alone. Quicksilver allows you to find what you need quickly and easily, then act... Read more
Tidy Up (Five Users) 4.1.5 - Find duplic...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more
Mellel 3.4.3 - The word processor of cho...
Mellel is the leading word processor for OS X and has been widely considered the industry standard since its inception. Mellel focuses on writers and scholars for technical writing and multilingual... Read more
Skype - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more

Swords & Crossbones: An Epic Pirate...
Swords & Crossbones: An Epic Pirate Story 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Camel Up (Games)
Camel Up 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Martian: Bring Him Home (Games)
The Martian: Bring Him Home 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Based on the best selling novel and critically acclaimed film, THE MARTIAN tells the story of Astronaut Mark... | Read more »
This Week at 148Apps: September 21-30, 2...
Leap Into Fall With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above... | Read more »
Tweetbot 4 for Twitter (Social Networki...
Tweetbot 4 for Twitter 4.0 Device: iOS Universal Category: Social Networking Price: $4.99, Version: 4.0 (iTunes) Description: *** 50% off for a limited time. *** | Read more »
Mori (Games)
Mori 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Stop, rewind and unwind with Mori. Time is always running, take a moment to take control. Mori is an action puzzle game about infinitely... | Read more »
100 Years' War (Games)
100 Years' War 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Tower in the Sky (Games)
Tower in the Sky 0.0.60 Device: iOS Universal Category: Games Price: $1.99, Version: 0.0.60 (iTunes) Description: | Read more »
hocus. (Games)
hocus. 1.0.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0.0 (iTunes) Description: New, polished, mind-bending, minimal puzzle game with dozens of levels and extra-ordinary design Features:- Beautifully crafted... | Read more »
Mos Speedrun 2 (Games)
Mos Speedrun 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Mos is back, in her biggest and most exciting adventure ever! Wall-jump to victory through 30 mysterious, action packed levels... | Read more »

Price Scanner via

13-inch 2.5GHz MacBook Pro (refurbished) avai...
Apple has Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros... Read more
27-inch 3.2GHz iMac on sale for $1689, save $...
Adorama has the 27″ 3.2GHz iMac on sale for $1689 including free shipping plus NY & NJ sales tax only. Their price is $110 off MSRP. Read more
12-inch Retina MacBooks on sale for up to $12...
B&H Photo has 12″ Retina MacBooks in stock today and on sale for up to $120 off MSRP. B&H will include free shipping, and there is NY sales tax only: - 12″ 1.1GHz Gray Retina MacBook: $1224 $... Read more
Tablets Shaping Up for Growth in 2016 – Strat...
Observing that Apple, Samsung, and Microsoft have refocused what tablet computers can do, market analysis firm Strategy Analytics believes there is immense opportunity for new and replacement sales... Read more
Apple Interbrand’s Number One Most Valuable G...
Apple and Google hold aced #1 and #2 spots respectively in Interbrand’s 2015 Best Global Brands Report, leading all tech brands that now comprise more than a third of the entire rankings value.... Read more
Apple offering refurbished 2015 13-inch Retin...
Apple is offering Certified Refurbished 2015 13″ Retina MacBook Pros for up to $270 (15%) off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: -... Read more
Apple refurbished 2015 MacBook Airs available...
Apple has Certified Refurbished 2015 11″ and 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and... Read more
Adobe Photoshop Elements 14 Gets Haze Removal...
The latest iteration of Adobe’s powerful consumer image editing appliction Photoshop Elements 14 analyzes your photo and removes background haze, so your shot looks sharp all the way to the horizon... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more
21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $100 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $1029.99 $70 off - 21″ 2.7GHz iMac: $1229 $70 off - 21″ 2.9GHz iMac: $... Read more

Jobs Board

Touch Validation Design (EE) - *Apple* Watc...
**Job Summary** Help launch next-generation Touch Technologies in Apple products. The Touch Technology team develops cutting-edge Touch solutions and technologies that Read more
WW Sales Strategy & Program Manager, *Ap...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
*Apple* TV Product Design Internship (Spring...
…the mechanical design effort associated with creating world-class products with the Apple TV PD Group. Responsibilities will include working closely with manufacturing, Read more
Product Design Engineer - *Apple* Watch - A...
**Job Summary** Product Design Engineer - WATCH ( Apple Watch) Be an integral part of a small and visible team of world-class Mechanical Engineers making Apple 's Read more
Senior Software System App Engineer, *Apple*...
**Job Summary** The Apple Watch system application team is looking for great software engineers who are comfortable working across all levels of the software stack. From Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.