Class jrpcgen

Method Details

• printHelp

  public static void printHelp()

  Print the help message describing the available command line options.

• createJavaSourceFile

  public static PrintWriter createJavaSourceFile(String classname)

  Creates a new source code file for a Java class based on its class name. Same as createJavaSourceFile(String, boolean) with the emitImport parameter set to true.

  Parameters:

  classname - Name of Java class to generate. Must not contain a file extension -- especially ".java" is invalid. When the source code file is created, ".java" is appended automatically.

  Returns:

  PrintWriter to send source code to.

• createJavaSourceFile

  public static PrintWriter createJavaSourceFile(String classname, boolean emitImports)

  Creates a new source code file for a Java class based on its class name. If an old version of the source file exists, it is renamed first. The backup will have the same name as the original file with "~" appended.

  Parameters:

  classname - Name of Java class to generate. Must not contain a file extension -- especially ".java" is invalid. When the source code file is created, ".java" is appended automatically.

  emitImports - if true, then import statements for the remotetea ONC/RPC package and IOExceptions.

  Returns:

  PrintWriter to send source code to.

• createSHA

  public static JrpcgenSHA createSHA(String classname)

  Create a new hash function object and initialize it using a class and package name.

  Parameters:

  classname - Name of class.

  Returns:

  hash function object.

• closeJavaSourceFile

  public static void closeJavaSourceFile()

  Closes the source code file previously opened with createJavaSourceFile. This method writes a trailer before closing the file.

• dumpConstantAndDependency

  public static void dumpConstantAndDependency(PrintWriter out, JrpcgenConst c)

  Dump the value of a constant and optionally first dump all constants it depends on.

• dumpConstants

  public static void dumpConstants()

  Generate source code file containing all constants defined in the x-file as well as all implicitely defined constants, like program, version and procedure numbers, etc. This method creates a public interface with the constants as public static final integers.

• dumpEnum

  public static void dumpEnum(JrpcgenEnum e)

  Generate a source code file containing all elements of an enumeration defined in a x-file.

  Parameters:

  e - Description of XDR enumeration.

• xdrBaseType

  public static String xdrBaseType(String type)

  Given a name of a data type return the name of the equivalent Java data type (if it exists), otherwise return null. NOTE: "opaque" is considered like "byte" to be a base type... FIXME: char/byte?

  Returns:

  Name of Java base data type or null if the given data type is not equivalent to one of Java's base data types.

• baseEnDecodingSyllable

  public static JrpcgenEnDecodingInfo baseEnDecodingSyllable(JrpcgenDeclaration decl)

  Return the en-/decoding syllable XXX appropriate for a base data type including arrays of base data types.

  Parameters:

  decl - declaration of a member of RPC struct or union.

  Returns:

  null, if the declaration does not specify a base data type. Otherwise a three-element String array, with [0] containing the type syllable for base type (including arrays), [1] containing parameter options when encoding (like maximum sizes, etc), and [2] containing options for decoding.

• codingMethod

  public static String codingMethod(JrpcgenDeclaration decl, boolean encode)

  Return en- or decoding method appropriate for a struct or union member.

• codingMethod

  public static String codingMethod(JrpcgenDeclaration decl, boolean encode, String oref)

  Return en- or decoding method appropriate for a struct or union member.

  Parameters:

  decl - declaration for which the en-/decoding Java source code be returned.

  encode - true if encoding method should be returned, false if decoding method is to be returned.

  oref - name of object reference or null if "this" should be used instead.

• checkForSpecials

  public static String checkForSpecials(String dataType)

  Checks whether a given data type identifier refers to an enumeration type and then returns Java's int data type instead. In case of the pseudo-type "opaque" return Java's byte data type. For all other data types, the data type identifier is returned unaltered.

  Parameters:

  dataType - data type identifier to check.

  Returns:

  data type identifier.

• checkForEnumValue

  public static String checkForEnumValue(String value)

  Checks whether a given value references an identifier and then returns the qualified identifier (interface where the value is defined in) or simply the value in case of an integer literal.

  Parameters:

  value - Either an identifier to resolve or an integer literal.

  Returns:

  Integer literal or qualified identifier.

• dumpStruct

  public static void dumpStruct(JrpcgenStruct s)

  Generate a source code file containing all elements of a struct defined in a x-file.

  Parameters:

  s - Description of XDR struct.

• dumpUnion

  public static void dumpUnion(JrpcgenUnion u)

  Generate a source code file containing all elements of a union defined in a x-file.

  Parameters:

  u - Description of XDR union.

• dumpTypedef

  public static void dumpTypedef(JrpcgenDeclaration d)

  Generate a source code file containing a wrapper class for a typedef defined in a x-file.

  Parameters:

  d - Description of XDR typedef.

• dumpClasses

  public static void dumpClasses()

  Generate source code files for all structures, unions and enumerations as well as constants. All constants, which do not belong to enumerations, are emitted to a single interface.

• dumpClientStubMethods

  public static void dumpClientStubMethods(PrintWriter out, JrpcgenVersionInfo versionInfo)

  Generate source code for client-side stub methods for a particular remote program version. The client-side stub methods take the parameter(s) from the caller, encode them and throw them over to the server. After receiving a reply, they will unpack and return it as the outcome of the method call.

  Parameters:

  out - Printer writer to send source code to.

  versionInfo - Information about the remote program version for which source code is to be generated.

• dumpClient

  public static void dumpClient(JrpcgenProgramInfo programInfo)

  Generate source code for the client stub proxy object. This client stub proxy object is then used by client applications to make remote procedure (aka method) calls to an ONC/RPC server.

• dumpServerStubMethodCall

  public static void dumpServerStubMethodCall(PrintWriter out, JrpcgenProcedureInfo proc)

• dumpServerStubMethods

  public static void dumpServerStubMethods(PrintWriter out, JrpcgenVersionInfo versionInfo)

  Generate public abstract method signatures for all remote procedure calls. This ensures that they have to be implemented before any derived server class gets usefull.

• dumpServer

  public static void dumpServer(JrpcgenProgramInfo programInfo)

• dumpFiles

  public static void dumpFiles()

  Create the source code files based on the parsed information from the x-file.

• main

  public static void main(String[] args)

  The main part of jrpcgen where all things start.

• doParse

  public static void doParse() throws FileNotFoundException, Exception

  The real parsing and code generation part. This has been factored out of main() in order to make it available as an Ant task.

  Throws:

  FileNotFoundException

  Exception