jdk/src/share/classes/java/nio/charset/Charset-X-Coder.java.template
changeset 18164 68f1bc4eadd4
parent 18156 edb590d448c5
child 18574 4aeaeb541678
equal deleted inserted replaced
18163:c0b32e884b70 18164:68f1bc4eadd4
   159         = { "RESET", "CODING", "CODING_END", "FLUSHED" };
   159         = { "RESET", "CODING", "CODING_END", "FLUSHED" };
   160 
   160 
   161 
   161 
   162     /**
   162     /**
   163      * Initializes a new $coder$.  The new $coder$ will have the given
   163      * Initializes a new $coder$.  The new $coder$ will have the given
   164      * $otypes-per-itype$ and replacement values. </p>
   164      * $otypes-per-itype$ and replacement values.
   165      *
   165      *
   166      * @param  average$ItypesPerOtype$
   166      * @param  average$ItypesPerOtype$
   167      *         A positive float value indicating the expected number of
   167      *         A positive float value indicating the expected number of
   168      *         $otype$s that will be produced for each input $itype$
   168      *         $otype$s that will be produced for each input $itype$
   169      *
   169      *
   205     }
   205     }
   206 
   206 
   207     /**
   207     /**
   208      * Initializes a new $coder$.  The new $coder$ will have the given
   208      * Initializes a new $coder$.  The new $coder$ will have the given
   209      * $otypes-per-itype$ values and its replacement will be the
   209      * $otypes-per-itype$ values and its replacement will be the
   210      * $replTypeName$ $defaultReplName$. </p>
   210      * $replTypeName$ $defaultReplName$.
   211      *
   211      *
   212      * @param  average$ItypesPerOtype$
   212      * @param  average$ItypesPerOtype$
   213      *         A positive float value indicating the expected number of
   213      *         A positive float value indicating the expected number of
   214      *         $otype$s that will be produced for each input $itype$
   214      *         $otype$s that will be produced for each input $itype$
   215      *
   215      *
   228              average$ItypesPerOtype$, max$ItypesPerOtype$,
   228              average$ItypesPerOtype$, max$ItypesPerOtype$,
   229              $defaultRepl$);
   229              $defaultRepl$);
   230     }
   230     }
   231 
   231 
   232     /**
   232     /**
   233      * Returns the charset that created this $coder$.  </p>
   233      * Returns the charset that created this $coder$.
   234      *
   234      *
   235      * @return  This $coder$'s charset
   235      * @return  This $coder$'s charset
   236      */
   236      */
   237     public final Charset charset() {
   237     public final Charset charset() {
   238         return charset;
   238         return charset;
   239     }
   239     }
   240 
   240 
   241     /**
   241     /**
   242      * Returns this $coder$'s replacement value. </p>
   242      * Returns this $coder$'s replacement value.
   243      *
   243      *
   244      * @return  This $coder$'s current replacement,
   244      * @return  This $coder$'s current replacement,
   245      *          which is never <tt>null</tt> and is never empty
   245      *          which is never <tt>null</tt> and is never empty
   246      */
   246      */
   247     public final $replType$ replacement() {
   247     public final $replType$ replacement() {
   349     }
   349     }
   350 
   350 
   351 #end[encoder]
   351 #end[encoder]
   352 
   352 
   353     /**
   353     /**
   354      * Returns this $coder$'s current action for malformed-input errors.  </p>
   354      * Returns this $coder$'s current action for malformed-input errors.
   355      *
   355      *
   356      * @return The current malformed-input action, which is never <tt>null</tt>
   356      * @return The current malformed-input action, which is never <tt>null</tt>
   357      */
   357      */
   358     public CodingErrorAction malformedInputAction() {
   358     public CodingErrorAction malformedInputAction() {
   359         return malformedInputAction;
   359         return malformedInputAction;
   360     }
   360     }
   361 
   361 
   362     /**
   362     /**
   363      * Changes this $coder$'s action for malformed-input errors.  </p>
   363      * Changes this $coder$'s action for malformed-input errors.
   364      *
   364      *
   365      * <p> This method invokes the {@link #implOnMalformedInput
   365      * <p> This method invokes the {@link #implOnMalformedInput
   366      * implOnMalformedInput} method, passing the new action.  </p>
   366      * implOnMalformedInput} method, passing the new action.  </p>
   367      *
   367      *
   368      * @param  newAction  The new action; must not be <tt>null</tt>
   368      * @param  newAction  The new action; must not be <tt>null</tt>
   389      */
   389      */
   390     protected void implOnMalformedInput(CodingErrorAction newAction) { }
   390     protected void implOnMalformedInput(CodingErrorAction newAction) { }
   391 
   391 
   392     /**
   392     /**
   393      * Returns this $coder$'s current action for unmappable-character errors.
   393      * Returns this $coder$'s current action for unmappable-character errors.
   394      * </p>
       
   395      *
   394      *
   396      * @return The current unmappable-character action, which is never
   395      * @return The current unmappable-character action, which is never
   397      *         <tt>null</tt>
   396      *         <tt>null</tt>
   398      */
   397      */
   399     public CodingErrorAction unmappableCharacterAction() {
   398     public CodingErrorAction unmappableCharacterAction() {
   433     protected void implOnUnmappableCharacter(CodingErrorAction newAction) { }
   432     protected void implOnUnmappableCharacter(CodingErrorAction newAction) { }
   434 
   433 
   435     /**
   434     /**
   436      * Returns the average number of $otype$s that will be produced for each
   435      * Returns the average number of $otype$s that will be produced for each
   437      * $itype$ of input.  This heuristic value may be used to estimate the size
   436      * $itype$ of input.  This heuristic value may be used to estimate the size
   438      * of the output buffer required for a given input sequence. </p>
   437      * of the output buffer required for a given input sequence.
   439      *
   438      *
   440      * @return  The average number of $otype$s produced
   439      * @return  The average number of $otype$s produced
   441      *          per $itype$ of input
   440      *          per $itype$ of input
   442      */
   441      */
   443     public final float average$ItypesPerOtype$() {
   442     public final float average$ItypesPerOtype$() {
   445     }
   444     }
   446 
   445 
   447     /**
   446     /**
   448      * Returns the maximum number of $otype$s that will be produced for each
   447      * Returns the maximum number of $otype$s that will be produced for each
   449      * $itype$ of input.  This value may be used to compute the worst-case size
   448      * $itype$ of input.  This value may be used to compute the worst-case size
   450      * of the output buffer required for a given input sequence. </p>
   449      * of the output buffer required for a given input sequence.
   451      *
   450      *
   452      * @return  The maximum number of $otype$s that will be produced per
   451      * @return  The maximum number of $otype$s that will be produced per
   453      *          $itype$ of input
   452      *          $itype$ of input
   454      */
   453      */
   455     public final float max$ItypesPerOtype$() {
   454     public final float max$ItypesPerOtype$() {