https://github.com/shannah/mirahmacrosforcodenameone

A Mirah macro library for use in Codename One projects
https://github.com/shannah/mirahmacrosforcodenameone

Last synced: about 1 month ago
JSON representation

A Mirah macro library for use in Codename One projects

• Host: GitHub
• URL: https://github.com/shannah/mirahmacrosforcodenameone
• Owner: shannah
• Created: 2014-10-18T00:46:30.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-11T23:39:21.000Z (about 10 years ago)
• Last Synced: 2023-04-01T05:43:39.391Z (over 1 year ago)
• Language: Mirah
• Size: 2.74 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
#Mirah Macros for Codename One

This project includes macros that are helpful for [Codename One](http://www.codenameone.com) projects.  The plan is to try to wrap as much common boiler-plate into macros so that developing Codename One apps will involve less typing.

Currently there is only one macro implemented:

`attr_externalizable` - A macro that allows you to generate Codename One classes that implement the [`Externalizable`](https://codenameone.googlecode.com/svn/trunk/CodenameOne/javadoc/com/codename1/io/Externalizable.html) interface (i.e. can be persisted in Storage and used in web services).

##License

Apache 2.0

##Requirements

NetBeans with the [Codename One plugin](http://www.codenameone.com) and the [Mirah Plugin](https://github.com/shannah/mirah-nbm) installed.

##Installation in Codename One Projects

1. Download the latest [MirahMacrosForCN1-macros.jar](https://github.com/shannah/MirahMacrosForCodenameOne/releases/tag/0.1.0) file.

2. Copy this jar file into the `lib/mirah/macros` directory of your Codename One project.

##Example Usage:

~~~

package ca.weblite.codename1.ws

import com.codename1.io.Externalizable

class FacultyMember implements Externalizable

  

  attr_externalizable 1, 'FacultyMember',

    name:String,

    age:int, 

    weight:double,

    child:FacultyMember

    

end

~~~

**Key Points:**

1. The class must implement the [Externalizable](https://codenameone.googlecode.com/svn/trunk/CodenameOne/javadoc/com/codename1/io/Externalizable.html) interface.

2. The class must have a no-args constructor.

3. The `attr_externalizable` call automatically generates the methods required to fulfill the `Externalizable` interface.  It takes the following params.  The signature for this is as follows:

 ~~~

 def attr_externalizable(version:int, objectId:String, properties:Hash)

 ~~~

The equivalent Java implementation of this class would be:

~~~

package ca.weblite.codename1.ws;

import com.codename1.io.Externalizable;

import java.io.DataOutputStream;

import java.io.DataInputStream;

import com.codename1.io.Util;

class FacultyMember implements Externalizable {

  

  private String name;

  private int age;

  private double weight;

  private FacultyMember child;

  

  public String name(){ return name;}

  public int age(){ return age;}

  public double weight(){ return weight;}

  public FacultyMember child(){ return child;}

  

  public void name_set(String name){ this.name = name;}

  public void age_set(int age){ this.age = age;}

  public void weight_set(double weight){ this.weight = weight;}

  public void child_set(FacultyMember child){ this.child = child;}

  

  public int getVersion(){ return 1;}

  

  public String getObjectId(){ return "Faculty Member";}

  

  public void externalize(DataOutputStream out){

      Util.writeUTF(name);

      out.writeInt(age);

      out.writeDouble(weight);

      Util.writeObject(child);

  } 

  

  public void internalize(DataInputStream input){

    name = Util.readUTF(input);

    age = input.readInt();

    weight = input.readDouble();

    child = (FacultyMember)Util.readObject(input);

  }

  

~~~

##See Also

For more information about Codename One persistence and the Externalizable interface check out:

1. A [blog post](http://sjhannah.com/blog/?p=234) I wrote on a the topic a while back.

2. [Store Data to Codename One Persistent Storage](https://www.youtube.com/watch?v=Q85K-nSbc_k) youtube video/screencast.

3. [The Codename One Developer Guide](http://www.codenameone.com/developer-guide.html)

For more information about Mirah, check out:

1. The [Mirah Website](http://www.mirah.org)

2. A [blog post](http://sjhannah.com/blog/?p=331) I wrote about Mirah development in Codename One using the Mirah Netbeans Plugin.

3. A [screencast](https://www.youtube.com/watch?v=uGgppdsMCjA) I made showing the use of the Mirah netbeans plugin to develop Codename One apps.

##Credits

This project was created and is maintained by [Steve Hannah](http://sjhannah.com)