org.keycloak.common.util.Base64.OutputStream クラス

org.keycloak.common.util.Base64.OutputStream の継承関係図

org.keycloak.common.util.Base64.OutputStream 連携図

公開メンバ関数
	OutputStream (java.io.OutputStream out)
	OutputStream (java.io.OutputStream out, int options)
void	write (int theByte) throws java.io.IOException
void	write (byte[] theBytes, int off, int len) throws java.io.IOException
void	flushBase64 () throws java.io.IOException
void	close () throws java.io.IOException
void	suspendEncoding () throws java.io.IOException
void	resumeEncoding ()

非公開変数類
boolean	encode
int	position
byte []	buffer
int	bufferLength
int	lineLength
boolean	breakLines
byte []	b4
boolean	suspendEncoding
int	options
byte []	decodabet

詳解

A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, and encode/decode to/from Base64 notation on the fly.

参照

Base64

から

1.3

構築子と解体子

OutputStream() [1/2]

org.keycloak.common.util.Base64.OutputStream.OutputStream ( java.io.OutputStream  out )

inline

Constructs a Base64.OutputStream in ENCODE mode.

引数

out	the java.io.OutputStream to which data will be written.

から

1.3

                                                        {
            this( out, ENCODE );
        }   // end constructor

OutputStream() [2/2]

org.keycloak.common.util.Base64.OutputStream.OutputStream ( java.io.OutputStream  out, int  options  )

inline

Constructs a Base64.OutputStream in either ENCODE or DECODE mode.

Valid options:

  ENCODE or DECODE: Encode or Decode as data is read.
  DO_BREAK_LINES: don't break lines at 76 characters
    (only meaningful when encoding)

Example: new Base64.OutputStream( out, Base64.ENCODE )

引数

out	the java.io.OutputStream to which data will be written.
options	Specified options.

参照

Base64::ENCODE

Base64::DECODE

Base64::DO_BREAK_LINES

から

1.3

                                                                     {
            super( out );
            this.breakLines   = (options & DO_BREAK_LINES) != 0;
            this.encode       = (options & ENCODE) != 0;
            this.bufferLength = encode ? 3 : 4;
            this.buffer       = new byte[ bufferLength ];
            this.position     = 0;
            this.lineLength   = 0;
            this.suspendEncoding = false;
            this.b4           = new byte[4];
            this.options      = options;
            this.decodabet    = getDecodabet(options);
        }   // end constructor

関数詳解

close()

void org.keycloak.common.util.Base64.OutputStream.close ( ) throws java.io.IOException

inline

Flushes and closes (I think, in the superclass) the stream.

から

1.3

                                                       {
            // 1. Ensure that pending characters are written
            flushBase64();

            // 2. Actually close the stream
            // Base class both flushes and closes.
            super.close();

            buffer = null;
            out    = null;
        }   // end close

flushBase64()

void org.keycloak.common.util.Base64.OutputStream.flushBase64 ( ) throws java.io.IOException

inline

Method added by PHIL. [Thanks, PHIL. -Rob] This pads the buffer without closing the stream.

例外

java.io.IOException

if there's an error.

                                                              {
            if( position > 0 ) {
                if( encode ) {
                    out.write( encode3to4( b4, buffer, position, options ) );
                    position = 0;
                }   // end if: encoding
                else {
                    throw new java.io.IOException( "Base64 input not properly padded." );
                }   // end else: decoding
            }   // end if: buffer partially full

        }   // end flush

resumeEncoding()

void org.keycloak.common.util.Base64.OutputStream.resumeEncoding ( )

inline

Resumes encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a stream.

から

1.5.1

                                     {
            this.suspendEncoding = false;
        }   // end resumeEncoding

suspendEncoding()

void org.keycloak.common.util.Base64.OutputStream.suspendEncoding ( ) throws java.io.IOException

inline

Suspends encoding of the stream. May be helpful if you need to embed a piece of base64-encoded data in a stream.

例外

java.io.IOException

if there's an error flushing

から

1.5.1

                                                                  {
            flushBase64();
            this.suspendEncoding = true;
        }   // end suspendEncoding

write() [1/2]

void org.keycloak.common.util.Base64.OutputStream.write ( int  theByte ) throws java.io.IOException

inline

Writes the byte to the output stream after converting to/from Base64 notation. When encoding, bytes are buffered three at a time before the output stream actually gets a write() call. When decoding, bytes are buffered four at a time.

引数

theByte

the byte to write

から

1.3

                                           {
            // Encoding suspended?
            if( suspendEncoding ) {
                this.out.write( theByte );
                return;
            }   // end if: supsended

            // Encode?
            if( encode ) {
                buffer[ position++ ] = (byte)theByte;
                if( position >= bufferLength ) { // Enough to encode.

                    this.out.write( encode3to4( b4, buffer, bufferLength, options ) );

                    lineLength += 4;
                    if( breakLines && lineLength >= MAX_LINE_LENGTH ) {
                        this.out.write( NEW_LINE );
                        lineLength = 0;
                    }   // end if: end of line

                    position = 0;
                }   // end if: enough to output
            }   // end if: encoding

            // Else, Decoding
            else {
                // Meaningful Base64 character?
                if( decodabet[ theByte & 0x7f ] > WHITE_SPACE_ENC ) {
                    buffer[ position++ ] = (byte)theByte;
                    if( position >= bufferLength ) { // Enough to output.

                        int len = Base64.decode4to3( buffer, 0, b4, 0, options );
                        out.write( b4, 0, len );
                        position = 0;
                    }   // end if: enough to output
                }   // end if: meaningful base64 character
                else if( decodabet[ theByte & 0x7f ] != WHITE_SPACE_ENC ) {
                    throw new java.io.IOException( "Invalid character in Base64 data." );
                }   // end else: not white space either
            }   // end else: decoding
        }   // end write

write() [2/2]

void org.keycloak.common.util.Base64.OutputStream.write ( byte []  theBytes, int  off, int  len  ) throws java.io.IOException

inline

Calls write(int) repeatedly until len bytes are written.

引数

theBytes	array from which to read bytes
off	offset for array
len	max number of bytes to read into array

から

1.3

                                           {
            // Encoding suspended?
            if( suspendEncoding ) {
                this.out.write( theBytes, off, len );
                return;
            }   // end if: supsended

            for( int i = 0; i < len; i++ ) {
                write( theBytes[ off + i ] );
            }   // end for: each byte written

        }   // end write

メンバ詳解

b4

byte [] org.keycloak.common.util.Base64.OutputStream.b4

private

breakLines

boolean org.keycloak.common.util.Base64.OutputStream.breakLines

private

buffer

byte [] org.keycloak.common.util.Base64.OutputStream.buffer

private

bufferLength

int org.keycloak.common.util.Base64.OutputStream.bufferLength

private

decodabet

byte [] org.keycloak.common.util.Base64.OutputStream.decodabet

private

encode

boolean org.keycloak.common.util.Base64.OutputStream.encode

private

lineLength

int org.keycloak.common.util.Base64.OutputStream.lineLength

private

options

int org.keycloak.common.util.Base64.OutputStream.options

private

position

int org.keycloak.common.util.Base64.OutputStream.position

private

suspendEncoding

boolean org.keycloak.common.util.Base64.OutputStream.suspendEncoding

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/common/util/Base64.java