com.github.miachm.sods

Class Macro

java.lang.Object

com.github.miachm.sods.Macro

All Implemented Interfaces:

Cloneable

public class Macro
extends Object
implements Cloneable

Represents a single macro module stored in an ODS file.

An ODS file can contain Basic macros organised in libraries. Each Macro object corresponds to one module inside a library and holds the module's name, source language, and source code.

The default language for programmatically-created macros is "StarBasic", which is what LibreOffice uses for Basic macros.

Constructor Summary

Constructors

Constructor and Description
Macro(String name, String code) Creates a new macro with StarBasic as the default language.
Macro(String name, String language, String code) Creates a new macro with an explicit source language.

Method Summary

Modifier and Type	Method and Description
Macro	clone()
boolean	equals(Object o)
String	getCode() Returns the macro source code.
String	getLanguage() Returns the script language (e.g.
String	getName() Returns the module name.
int	hashCode()
void	setCode(String code) Sets the macro source code.
void	setLanguage(String language) Sets the script language.
void	setName(String name) Sets the module name.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Macro

public Macro(String name,
             String code)

Creates a new macro with StarBasic as the default language.

Parameters:

name - Module name (e.g. "Module1"). Must not be null.

code - Basic source code. Must not be null.

Throws:

NullPointerException - if name or code is null.

Macro

public Macro(String name,
             String language,
             String code)

Creates a new macro with an explicit source language.

Parameters:

name - Module name. Must not be null.

language - Script language (e.g. "StarBasic"). Must not be null.

code - Source code. Must not be null.

Throws:

NullPointerException - if any argument is null.

Method Detail

getName

public String getName()

Returns the module name.

Returns:

module name, never null.

setName

public void setName(String name)

Sets the module name.

Parameters:

name - module name, must not be null.

getLanguage

public String getLanguage()

Returns the script language (e.g. "StarBasic").

Returns:

language string, never null.

setLanguage

public void setLanguage(String language)

Sets the script language.

Parameters:

language - script language, must not be null.

getCode

public String getCode()

Returns the macro source code.

Returns:

source code, never null.

setCode

public void setCode(String code)

Sets the macro source code.

Parameters:

code - source code, must not be null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public Macro clone()

Overrides:

clone in class Object