Class Surrogate.Generator

  • Enclosing class:
    Surrogate

    public static class Surrogate.Generator
    extends java.lang.Object
    Surrogate generation support. Charset implementations may use instances of this class to handle the details of generating UTF-16 surrogate pairs.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.nio.charset.CoderResult error  
    • Constructor Summary

      Constructors 
      Constructor Description
      Generator()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.nio.charset.CoderResult error()
      If the previous generation operation detected an error, return the object describing that error.
      int generate​(int uc, int len, char[] da, int dp, int dl)
      Generates one or two UTF-16 characters to represent the given UCS-4 character.
      int generate​(int uc, int len, java.nio.CharBuffer dst)
      Generates one or two UTF-16 characters to represent the given UCS-4 character.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • error

        private java.nio.charset.CoderResult error
    • Constructor Detail

      • Generator

        public Generator()
    • Method Detail

      • error

        public java.nio.charset.CoderResult error()
        If the previous generation operation detected an error, return the object describing that error.
      • generate

        public int generate​(int uc,
                            int len,
                            java.nio.CharBuffer dst)
        Generates one or two UTF-16 characters to represent the given UCS-4 character.
        Parameters:
        uc - The UCS-4 character
        len - The number of input bytes from which the UCS-4 value was constructed (used when creating result objects)
        dst - The destination buffer, to which one or two UTF-16 characters will be written
        Returns:
        Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object
      • generate

        public int generate​(int uc,
                            int len,
                            char[] da,
                            int dp,
                            int dl)
        Generates one or two UTF-16 characters to represent the given UCS-4 character.
        Parameters:
        uc - The UCS-4 character
        len - The number of input bytes from which the UCS-4 value was constructed (used when creating result objects)
        da - The destination array, to which one or two UTF-16 characters will be written
        dp - The destination position
        dl - The destination limit
        Returns:
        Either a positive count of the number of UTF-16 characters written to the destination buffer, or -1, in which case error() will return a descriptive result object