docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 6.1System Developer Manual JavaReference for Roxen Java classes
Copyright © 2018, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com

   

AbstractLocationModule
ExperimentalModule
FileExtensionModule
Frame
HTTP
LastResortModule
LocationModule
Module
ParserModule
ProviderModule
RXML
RXML.Backtrace
RoxenClassLoader
RoxenConfiguration
RoxenFileResponse
RoxenLib
RoxenRXMLResponse
RoxenRequest
RoxenResponse
RoxenStringResponse
SecurityModule
SimpleTagCaller
UniqueModule

RXML

: Class RXML

com.roxen.roxen
Class RXML


java.lang.Object
  |
  +--com.roxen.roxen.RXML
public class RXML
extends java.lang.Object

RXML framework

Inner Class Summary
static interface RXML.Backtrace
          The object used to throw RXML errors.
 
Method Summary
static void deleteVar(java.lang.String var)
          Removes a variable in the current scope.
static void deleteVar(java.lang.String var, java.lang.String scopeName)
          Removes a variable in the specified scope.
static java.lang.Object getVar(java.lang.String var)
          Returns the value a variable in the current scope.
static java.lang.Object getVar(java.lang.String var, java.lang.String scopeName)
          Returns the value a variable in the specified scope.
static void parseError(java.lang.String msg)
          Throws an RXML parse error with a dump of the parser stack in the current context.
static void runError(java.lang.String msg)
          Throws an RXML run error with a dump of the parser stack in the current context.
static java.lang.Object setVar(java.lang.String var, java.lang.Object val)
          Sets the value of a variable in the current scope.
static java.lang.Object setVar(java.lang.String var, java.lang.Object val, java.lang.String scopeName)
          Sets the value of a variable in the specified scope.
static void tagDebug(java.lang.String msg)
          Writes the message to the debug log if the innermost tag being executed has FLAG_DEBUG set.
static void userDeleteVar(java.lang.String var)
          Removes a variable in the current scope.
static void userDeleteVar(java.lang.String var, java.lang.String scopeName)
          Removes a variable in the specified scope.
static java.lang.Object userGetVar(java.lang.String var)
          Returns the value a variable in the current scope.
static java.lang.Object userGetVar(java.lang.String var, java.lang.String scopeName)
          Returns the value a variable in the specified scope.
static java.lang.Object userSetVar(java.lang.String var, java.lang.Object val)
          Sets the value of a variable in the current scope.
static java.lang.Object userSetVar(java.lang.String var, java.lang.Object val, java.lang.String scopeName)
          Sets the value of a variable in the specified scope.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getVar


public static java.lang.Object getVar(java.lang.String var,
                                      java.lang.String scopeName)
Returns the value a variable in the specified scope. Returns null if there's no such variable (or it's nil).
Parameters:
var - the name of the variable
scopeName - the name of the scope
Returns:
the value of the variable, or null

getVar


public static java.lang.Object getVar(java.lang.String var)
Returns the value a variable in the current scope. Returns null if there's no such variable (or it's nil).
Parameters:
var - the name of the variable
Returns:
the value of the variable, or null

userGetVar


public static java.lang.Object userGetVar(java.lang.String var,
                                          java.lang.String scopeName)
Returns the value a variable in the specified scope. Returns null if there's no such variable (or it's nil). The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable
scopeName - the name of the scope
Returns:
the value of the variable, or null

userGetVar


public static java.lang.Object userGetVar(java.lang.String var)
Returns the value a variable in the current scope. Returns null if there's no such variable (or it's nil). The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable
Returns:
the value of the variable, or null

setVar


public static java.lang.Object setVar(java.lang.String var,
                                      java.lang.Object val,
                                      java.lang.String scopeName)
Sets the value of a variable in the specified scope. Returns val.
Parameters:
var - the name of the variable
val - the new value for the variable
scopeName - the name of the scope
Returns:
the same value as was passed in

setVar


public static java.lang.Object setVar(java.lang.String var,
                                      java.lang.Object val)
Sets the value of a variable in the current scope. Returns val.
Parameters:
var - the name of the variable
val - the new value for the variable
Returns:
the same value as was passed in

userSetVar


public static java.lang.Object userSetVar(java.lang.String var,
                                          java.lang.Object val,
                                          java.lang.String scopeName)
Sets the value of a variable in the specified scope. Returns val. The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable
val - the new value for the variable
scopeName - the name of the scope
Returns:
the same value as was passed in

userSetVar


public static java.lang.Object userSetVar(java.lang.String var,
                                          java.lang.Object val)
Sets the value of a variable in the current scope. Returns val. The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable
val - the new value for the variable
Returns:
the same value as was passed in

deleteVar


public static void deleteVar(java.lang.String var,
                             java.lang.String scopeName)
Removes a variable in the specified scope.
Parameters:
var - the name of the variable
scopeName - the name of the scope

deleteVar


public static void deleteVar(java.lang.String var)
Removes a variable in the current scope.
Parameters:
var - the name of the variable

userDeleteVar


public static void userDeleteVar(java.lang.String var,
                                 java.lang.String scopeName)
Removes a variable in the specified scope. The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable
scopeName - the name of the scope

userDeleteVar


public static void userDeleteVar(java.lang.String var)
Removes a variable in the current scope. The var string is also parsed for scope and/or subindexes, e.g. "scope.var.1.foo".
Parameters:
var - the name of the variable

runError


public static void runError(java.lang.String msg)
                     throws RXML.Backtrace
Throws an RXML run error with a dump of the parser stack in the current context. This is intended to be used by tags for errors that can occur during normal operation, such as when the connection to an SQL server fails.

parseError


public static void parseError(java.lang.String msg)
                       throws RXML.Backtrace
Throws an RXML parse error with a dump of the parser stack in the current context. This is intended to be used for programming errors in the RXML code, such as lookups in nonexisting scopes and invalid arguments to a tag.

tagDebug


public static void tagDebug(java.lang.String msg)
Writes the message to the debug log if the innermost tag being executed has FLAG_DEBUG set.