    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements.  See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache License, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License.  You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the License for the specific language governing permissions and
    015     * limitations under the License.
    016     */
    017    package org.apache.commons.math3.exception.util;
    018
    019    import java.util.Locale;
    020    import java.util.MissingResourceException;
    021    import java.util.ResourceBundle;
    022
    023    /**
    024     * Enumeration for localized messages formats used in exceptions messages.
    025     * <p>
    026     * The constants in this enumeration represent the available
    027     * formats as localized strings. These formats are intended to be
    028     * localized using simple properties files, using the constant
    029     * name as the key and the property value as the message format.
    030     * The source English format is provided in the constants themselves
    031     * to serve both as a reminder for developers to understand the parameters
    032     * needed by each format, as a basis for translators to create
    033     * localized properties files, and as a default format if some
    034     * translation is missing.
    035     * </p>
    036     * @since 2.2
    037     * @version $Id: LocalizedFormats.java 1421448 2012-12-13 19:45:57Z tn $
    038     */
    039    public enum LocalizedFormats implements Localizable {
    040
    041        // CHECKSTYLE: stop MultipleVariableDeclarations
    042        // CHECKSTYLE: stop JavadocVariable
    043
    044        ARGUMENT_OUTSIDE_DOMAIN("Argument {0} outside domain [{1} ; {2}]"),
    045        ARRAY_SIZE_EXCEEDS_MAX_VARIABLES("array size cannot be greater than {0}"),
    046        ARRAY_SIZES_SHOULD_HAVE_DIFFERENCE_1("array sizes should have difference 1 ({0} != {1} + 1)"),
    047        ARRAY_SUMS_TO_ZERO("array sums to zero"),
    048        ASSYMETRIC_EIGEN_NOT_SUPPORTED("eigen decomposition of assymetric matrices not supported yet"),
    049        AT_LEAST_ONE_COLUMN("matrix must have at least one column"),
    050        AT_LEAST_ONE_ROW("matrix must have at least one row"),
    051        BANDWIDTH("bandwidth ({0})"),
    052        BINOMIAL_INVALID_PARAMETERS_ORDER("must have n >= k for binomial coefficient (n, k), got k = {0}, n = {1}"),
    053        BINOMIAL_NEGATIVE_PARAMETER("must have n >= 0 for binomial coefficient (n, k), got n = {0}"),
    054        CANNOT_CLEAR_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be cleared"),
    055        CANNOT_COMPUTE_0TH_ROOT_OF_UNITY("cannot compute 0-th root of unity, indefinite result"),
    056        CANNOT_COMPUTE_BETA_DENSITY_AT_0_FOR_SOME_ALPHA("cannot compute beta density at 0 when alpha = {0,number}"),
    057        CANNOT_COMPUTE_BETA_DENSITY_AT_1_FOR_SOME_BETA("cannot compute beta density at 1 when beta = %.3g"),
    058        CANNOT_COMPUTE_NTH_ROOT_FOR_NEGATIVE_N("cannot compute nth root for null or negative n: {0}"),
    059        CANNOT_DISCARD_NEGATIVE_NUMBER_OF_ELEMENTS("cannot discard a negative number of elements ({0})"),
    060        CANNOT_FORMAT_INSTANCE_AS_3D_VECTOR("cannot format a {0} instance as a 3D vector"),
    061        CANNOT_FORMAT_INSTANCE_AS_COMPLEX("cannot format a {0} instance as a complex number"),
    062        CANNOT_FORMAT_INSTANCE_AS_REAL_VECTOR("cannot format a {0} instance as a real vector"),
    063        CANNOT_FORMAT_OBJECT_TO_FRACTION("cannot format given object as a fraction number"),
    064        CANNOT_INCREMENT_STATISTIC_CONSTRUCTED_FROM_EXTERNAL_MOMENTS("statistics constructed from external moments cannot be incremented"),
    065        CANNOT_NORMALIZE_A_ZERO_NORM_VECTOR("cannot normalize a zero norm vector"),
    066        CANNOT_RETRIEVE_AT_NEGATIVE_INDEX("elements cannot be retrieved from a negative array index {0}"),
    067        CANNOT_SET_AT_NEGATIVE_INDEX("cannot set an element at a negative index {0}"),
    068        CANNOT_SUBSTITUTE_ELEMENT_FROM_EMPTY_ARRAY("cannot substitute an element from an empty array"),
    069        CANNOT_TRANSFORM_TO_DOUBLE("Conversion Exception in Transformation: {0}"),
    070        CARDAN_ANGLES_SINGULARITY("Cardan angles singularity"),
    071        CLASS_DOESNT_IMPLEMENT_COMPARABLE("class ({0}) does not implement Comparable"),
    072        CLOSEST_ORTHOGONAL_MATRIX_HAS_NEGATIVE_DETERMINANT("the closest orthogonal matrix has a negative determinant {0}"),
    073        COLUMN_INDEX_OUT_OF_RANGE("column index {0} out of allowed range [{1}, {2}]"),
    074        COLUMN_INDEX("column index ({0})"), /* keep */
    075        CONTINUED_FRACTION_INFINITY_DIVERGENCE("Continued fraction convergents diverged to +/- infinity for value {0}"),
    076        CONTINUED_FRACTION_NAN_DIVERGENCE("Continued fraction diverged to NaN for value {0}"),
    077        CONTRACTION_CRITERIA_SMALLER_THAN_EXPANSION_FACTOR("contraction criteria ({0}) smaller than the expansion factor ({1}).  This would lead to a never ending loop of expansion and contraction as a newly expanded internal storage array would immediately satisfy the criteria for contraction."),
    078        CONTRACTION_CRITERIA_SMALLER_THAN_ONE("contraction criteria smaller than one ({0}).  This would lead to a never ending loop of expansion and contraction as an internal storage array length equal to the number of elements would satisfy the contraction criteria."),
    079        CONVERGENCE_FAILED("convergence failed"), /* keep */
    080        CROSSING_BOUNDARY_LOOPS("some outline boundary loops cross each other"),
    081        CROSSOVER_RATE("crossover rate ({0})"),
    082        CUMULATIVE_PROBABILITY_RETURNED_NAN("Cumulative probability function returned NaN for argument {0} p = {1}"),
    083        DIFFERENT_ROWS_LENGTHS("some rows have length {0} while others have length {1}"),
    084        DIFFERENT_ORIG_AND_PERMUTED_DATA("original and permuted data must contain the same elements"),
    085        DIGEST_NOT_INITIALIZED("digest not initialized"),
    086        DIMENSIONS_MISMATCH_2x2("got {0}x{1} but expected {2}x{3}"), /* keep */
    087        DIMENSIONS_MISMATCH_SIMPLE("{0} != {1}"), /* keep */
    088        DIMENSIONS_MISMATCH("dimensions mismatch"), /* keep */
    089        DISCRETE_CUMULATIVE_PROBABILITY_RETURNED_NAN("Discrete cumulative probability function returned NaN for argument {0}"),
    090        DISTRIBUTION_NOT_LOADED("distribution not loaded"),
    091        DUPLICATED_ABSCISSA_DIVISION_BY_ZERO("duplicated abscissa {0} causes division by zero"),
    092        ELITISM_RATE("elitism rate ({0})"),
    093        EMPTY_CLUSTER_IN_K_MEANS("empty cluster in k-means"),
    094        EMPTY_INTERPOLATION_SAMPLE("sample for interpolation is empty"),
    095        EMPTY_POLYNOMIALS_COEFFICIENTS_ARRAY("empty polynomials coefficients array"), /* keep */
    096        EMPTY_SELECTED_COLUMN_INDEX_ARRAY("empty selected column index array"),
    097        EMPTY_SELECTED_ROW_INDEX_ARRAY("empty selected row index array"),
    098        EMPTY_STRING_FOR_IMAGINARY_CHARACTER("empty string for imaginary character"),
    099        ENDPOINTS_NOT_AN_INTERVAL("endpoints do not specify an interval: [{0}, {1}]"),
    100        EQUAL_VERTICES_IN_SIMPLEX("equal vertices {0} and {1} in simplex configuration"),
    101        EULER_ANGLES_SINGULARITY("Euler angles singularity"),
    102        EVALUATION("evaluation"), /* keep */
    103        EXPANSION_FACTOR_SMALLER_THAN_ONE("expansion factor smaller than one ({0})"),
    104        FACTORIAL_NEGATIVE_PARAMETER("must have n >= 0 for n!, got n = {0}"),
    105        FAILED_BRACKETING("number of iterations={4}, maximum iterations={5}, initial={6}, lower bound={7}, upper bound={8}, final a value={0}, final b value={1}, f(a)={2}, f(b)={3}"),
    106        FAILED_FRACTION_CONVERSION("Unable to convert {0} to fraction after {1} iterations"),
    107        FIRST_COLUMNS_NOT_INITIALIZED_YET("first {0} columns are not initialized yet"),
    108        FIRST_ELEMENT_NOT_ZERO("first element is not 0: {0}"),
    109        FIRST_ROWS_NOT_INITIALIZED_YET("first {0} rows are not initialized yet"),
    110        FRACTION_CONVERSION_OVERFLOW("Overflow trying to convert {0} to fraction ({1}/{2})"),
    111        FUNCTION_NOT_DIFFERENTIABLE("function is not differentiable"),
    112        FUNCTION_NOT_POLYNOMIAL("function is not polynomial"),
    113        GCD_OVERFLOW_32_BITS("overflow: gcd({0}, {1}) is 2^31"),
    114        GCD_OVERFLOW_64_BITS("overflow: gcd({0}, {1}) is 2^63"),
    115        HOLE_BETWEEN_MODELS_TIME_RANGES("{0} wide hole between models time ranges"),
    116        ILL_CONDITIONED_OPERATOR("condition number {1} is too high "),
    117        INDEX_LARGER_THAN_MAX("the index specified: {0} is larger than the current maximal index {1}"),
    118        INDEX_NOT_POSITIVE("index ({0}) is not positive"),
    119        INDEX_OUT_OF_RANGE("index {0} out of allowed range [{1}, {2}]"),
    120        INDEX("index ({0})"), /* keep */
    121        NOT_FINITE_NUMBER("{0} is not a finite number"), /* keep */
    122        INFINITE_BOUND("interval bounds must be finite"),
    123        ARRAY_ELEMENT("value {0} at index {1}"), /* keep */
    124        INFINITE_ARRAY_ELEMENT("Array contains an infinite element, {0} at index {1}"),
    125        INFINITE_VALUE_CONVERSION("cannot convert infinite value"),
    126        INITIAL_CAPACITY_NOT_POSITIVE("initial capacity ({0}) is not positive"),
    127        INITIAL_COLUMN_AFTER_FINAL_COLUMN("initial column {1} after final column {0}"),
    128        INITIAL_ROW_AFTER_FINAL_ROW("initial row {1} after final row {0}"),
    129        @Deprecated
    130        INPUT_DATA_FROM_UNSUPPORTED_DATASOURCE("input data comes from unsupported datasource: {0}, supported sources: {1}, {2}"),
    131        INSTANCES_NOT_COMPARABLE_TO_EXISTING_VALUES("instance of class {0} not comparable to existing values"),
    132        INSUFFICIENT_DATA_FOR_T_STATISTIC("insufficient data for t statistic, needs at least 2, got {0}"),
    133        INSUFFICIENT_DIMENSION("insufficient dimension {0}, must be at least {1}"),
    134        DIMENSION("dimension ({0})"), /* keep */
    135        INSUFFICIENT_OBSERVED_POINTS_IN_SAMPLE("sample contains {0} observed points, at least {1} are required"),
    136        INSUFFICIENT_ROWS_AND_COLUMNS("insufficient data: only {0} rows and {1} columns."),
    137        INTEGRATION_METHOD_NEEDS_AT_LEAST_TWO_PREVIOUS_POINTS("multistep method needs at least {0} previous steps, got {1}"),
    138        INTERNAL_ERROR("internal error, please fill a bug report at {0}"),
    139        INVALID_BINARY_DIGIT("invalid binary digit: {0}"),
    140        INVALID_BINARY_CHROMOSOME("binary mutation works on BinaryChromosome only"),
    141        INVALID_BRACKETING_PARAMETERS("invalid bracketing parameters:  lower bound={0},  initial={1}, upper bound={2}"),
    142        INVALID_FIXED_LENGTH_CHROMOSOME("one-point crossover only works with fixed-length chromosomes"),
    143        INVALID_INTERVAL_INITIAL_VALUE_PARAMETERS("invalid interval, initial value parameters:  lower={0}, initial={1}, upper={2}"),
    144        INVALID_ITERATIONS_LIMITS("invalid iteration limits: min={0}, max={1}"),
    145        INVALID_MAX_ITERATIONS("bad value for maximum iterations number: {0}"),
    146        NOT_ENOUGH_DATA_REGRESSION("the number of observations is not sufficient to conduct regression"),
    147        INVALID_REGRESSION_ARRAY("input data array length = {0} does not match the number of observations = {1} and the number of regressors = {2}"),
    148        INVALID_REGRESSION_OBSERVATION("length of regressor array = {0} does not match the number of variables = {1} in the model"),
    149        INVALID_ROUNDING_METHOD("invalid rounding method {0}, valid methods: {1} ({2}), {3} ({4}), {5} ({6}), {7} ({8}), {9} ({10}), {11} ({12}), {13} ({14}), {15} ({16})"),
    150        ITERATOR_EXHAUSTED("iterator exhausted"),
    151        ITERATIONS("iterations"), /* keep */
    152        LCM_OVERFLOW_32_BITS("overflow: lcm({0}, {1}) is 2^31"),
    153        LCM_OVERFLOW_64_BITS("overflow: lcm({0}, {1}) is 2^63"),
    154        LIST_OF_CHROMOSOMES_BIGGER_THAN_POPULATION_SIZE("list of chromosomes bigger than maxPopulationSize"),
    155        LOESS_EXPECTS_AT_LEAST_ONE_POINT("Loess expects at least 1 point"),
    156        LOWER_BOUND_NOT_BELOW_UPPER_BOUND("lower bound ({0}) must be strictly less than upper bound ({1})"), /* keep */
    157        LOWER_ENDPOINT_ABOVE_UPPER_ENDPOINT("lower endpoint ({0}) must be less than or equal to upper endpoint ({1})"),
    158        MAP_MODIFIED_WHILE_ITERATING("map has been modified while iterating"),
    159        EVALUATIONS("evaluations"), /* keep */
    160        MAX_COUNT_EXCEEDED("maximal count ({0}) exceeded"), /* keep */
    161        MAX_ITERATIONS_EXCEEDED("maximal number of iterations ({0}) exceeded"),
    162        MINIMAL_STEPSIZE_REACHED_DURING_INTEGRATION("minimal step size ({1,number,0.00E00}) reached, integration needs {0,number,0.00E00}"),
    163        MISMATCHED_LOESS_ABSCISSA_ORDINATE_ARRAYS("Loess expects the abscissa and ordinate arrays to be of the same size, but got {0} abscissae and {1} ordinatae"),
    164        MUTATION_RATE("mutation rate ({0})"),
    165        NAN_ELEMENT_AT_INDEX("element {0} is NaN"),
    166        NAN_VALUE_CONVERSION("cannot convert NaN value"),
    167        NEGATIVE_BRIGHTNESS_EXPONENT("brightness exponent should be positive or null, but got {0}"),
    168        NEGATIVE_COMPLEX_MODULE("negative complex module {0}"),
    169        NEGATIVE_ELEMENT_AT_2D_INDEX("element ({0}, {1}) is negative: {2}"),
    170        NEGATIVE_ELEMENT_AT_INDEX("element {0} is negative: {1}"),
    171        NEGATIVE_NUMBER_OF_SUCCESSES("number of successes must be non-negative ({0})"),
    172        NUMBER_OF_SUCCESSES("number of successes ({0})"), /* keep */
    173        NEGATIVE_NUMBER_OF_TRIALS("number of trials must be non-negative ({0})"),
    174        NUMBER_OF_INTERPOLATION_POINTS("number of interpolation points ({0})"), /* keep */
    175        NUMBER_OF_TRIALS("number of trials ({0})"),
    176        ROBUSTNESS_ITERATIONS("number of robustness iterations ({0})"),
    177        START_POSITION("start position ({0})"), /* keep */
    178        NON_CONVERGENT_CONTINUED_FRACTION("Continued fraction convergents failed to converge (in less than {0} iterations) for value {1}"),
    179        NON_INVERTIBLE_TRANSFORM("non-invertible affine transform collapses some lines into single points"),
    180        NON_POSITIVE_MICROSPHERE_ELEMENTS("number of microsphere elements must be positive, but got {0}"),
    181        NON_POSITIVE_POLYNOMIAL_DEGREE("polynomial degree must be positive: degree={0}"),
    182        NON_REAL_FINITE_ABSCISSA("all abscissae must be finite real numbers, but {0}-th is {1}"),
    183        NON_REAL_FINITE_ORDINATE("all ordinatae must be finite real numbers, but {0}-th is {1}"),
    184        NON_REAL_FINITE_WEIGHT("all weights must be finite real numbers, but {0}-th is {1}"),
    185        NON_SQUARE_MATRIX("non square ({0}x{1}) matrix"),
    186        NORM("Norm ({0})"), /* keep */
    187        NORMALIZE_INFINITE("Cannot normalize to an infinite value"),
    188        NORMALIZE_NAN("Cannot normalize to NaN"),
    189        NOT_ADDITION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not addition compatible"),
    190        NOT_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not decreasing ({2} < {3})"),
    191        NOT_DECREASING_SEQUENCE("points {3} and {2} are not decreasing ({1} < {0})"), /* keep */
    192        NOT_ENOUGH_DATA_FOR_NUMBER_OF_PREDICTORS("not enough data ({0} rows) for this many predictors ({1} predictors)"),
    193        NOT_ENOUGH_POINTS_IN_SPLINE_PARTITION("spline partition must have at least {0} points, got {1}"),
    194        NOT_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not increasing ({2} > {3})"),
    195        NOT_INCREASING_SEQUENCE("points {3} and {2} are not increasing ({1} > {0})"), /* keep */
    196        NOT_MULTIPLICATION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not multiplication compatible"),
    197        NOT_POSITIVE_DEFINITE_MATRIX("not positive definite matrix"), /* keep */
    198        NON_POSITIVE_DEFINITE_MATRIX("not positive definite matrix: diagonal element at ({1},{1}) is smaller than {2} ({0})"),
    199        NON_POSITIVE_DEFINITE_OPERATOR("non positive definite linear operator"), /* keep */
    200        NON_SELF_ADJOINT_OPERATOR("non self-adjoint linear operator"), /* keep */
    201        NON_SQUARE_OPERATOR("non square ({0}x{1}) linear operator"), /* keep */
    202        DEGREES_OF_FREEDOM("degrees of freedom ({0})"), /* keep */
    203        NOT_POSITIVE_DEGREES_OF_FREEDOM("degrees of freedom must be positive ({0})"),
    204        NOT_POSITIVE_ELEMENT_AT_INDEX("element {0} is not positive: {1}"),
    205        NOT_POSITIVE_EXPONENT("invalid exponent {0} (must be positive)"),
    206        NUMBER_OF_ELEMENTS_SHOULD_BE_POSITIVE("number of elements should be positive ({0})"),
    207        EXPONENT("exponent ({0})"), /* keep */
    208        NOT_POSITIVE_LENGTH("length must be positive ({0})"),
    209        LENGTH("length ({0})"), /* keep */
    210        NOT_POSITIVE_MEAN("mean must be positive ({0})"),
    211        MEAN("mean ({0})"), /* keep */
    212        NOT_POSITIVE_NUMBER_OF_SAMPLES("number of sample is not positive: {0}"),
    213        NUMBER_OF_SAMPLES("number of samples ({0})"), /* keep */
    214        NOT_POSITIVE_PERMUTATION("permutation k ({0}) must be positive"),
    215        PERMUTATION_SIZE("permutation size ({0}"), /* keep */
    216        NOT_POSITIVE_POISSON_MEAN("the Poisson mean must be positive ({0})"),
    217        NOT_POSITIVE_POPULATION_SIZE("population size must be positive ({0})"),
    218        POPULATION_SIZE("population size ({0})"), /* keep */
    219        NOT_POSITIVE_ROW_DIMENSION("invalid row dimension: {0} (must be positive)"),
    220        NOT_POSITIVE_SAMPLE_SIZE("sample size must be positive ({0})"),
    221        NOT_POSITIVE_SCALE("scale must be positive ({0})"),
    222        SCALE("scale ({0})"), /* keep */
    223        NOT_POSITIVE_SHAPE("shape must be positive ({0})"),
    224        SHAPE("shape ({0})"), /* keep */
    225        NOT_POSITIVE_STANDARD_DEVIATION("standard deviation must be positive ({0})"),
    226        STANDARD_DEVIATION("standard deviation ({0})"), /* keep */
    227        NOT_POSITIVE_UPPER_BOUND("upper bound must be positive ({0})"),
    228        NOT_POSITIVE_WINDOW_SIZE("window size must be positive ({0})"),
    229        NOT_POWER_OF_TWO("{0} is not a power of 2"),
    230        NOT_POWER_OF_TWO_CONSIDER_PADDING("{0} is not a power of 2, consider padding for fix"),
    231        NOT_POWER_OF_TWO_PLUS_ONE("{0} is not a power of 2 plus one"),
    232        NOT_STRICTLY_DECREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly decreasing ({2} <= {3})"),
    233        NOT_STRICTLY_DECREASING_SEQUENCE("points {3} and {2} are not strictly decreasing ({1} <= {0})"), /* keep */
    234        NOT_STRICTLY_INCREASING_KNOT_VALUES("knot values must be strictly increasing"),
    235        NOT_STRICTLY_INCREASING_NUMBER_OF_POINTS("points {0} and {1} are not strictly increasing ({2} >= {3})"),
    236        NOT_STRICTLY_INCREASING_SEQUENCE("points {3} and {2} are not strictly increasing ({1} >= {0})"), /* keep */
    237        NOT_SUBTRACTION_COMPATIBLE_MATRICES("{0}x{1} and {2}x{3} matrices are not subtraction compatible"),
    238        NOT_SUPPORTED_IN_DIMENSION_N("method not supported in dimension {0}"),
    239        NOT_SYMMETRIC_MATRIX("not symmetric matrix"),
    240        NON_SYMMETRIC_MATRIX("non symmetric matrix: the difference between entries at ({0},{1}) and ({1},{0}) is larger than {2}"), /* keep */
    241        NO_BIN_SELECTED("no bin selected"),
    242        NO_CONVERGENCE_WITH_ANY_START_POINT("none of the {0} start points lead to convergence"), /* keep */
    243        NO_DATA("no data"), /* keep */
    244        NO_DEGREES_OF_FREEDOM("no degrees of freedom ({0} measurements, {1} parameters)"),
    245        NO_DENSITY_FOR_THIS_DISTRIBUTION("This distribution does not have a density function implemented"),
    246        NO_FEASIBLE_SOLUTION("no feasible solution"),
    247        NO_OPTIMUM_COMPUTED_YET("no optimum computed yet"), /* keep */
    248        NO_REGRESSORS("Regression model must include at least one regressor"),
    249        NO_RESULT_AVAILABLE("no result available"),
    250        NO_SUCH_MATRIX_ENTRY("no entry at indices ({0}, {1}) in a {2}x{3} matrix"),
    251        NAN_NOT_ALLOWED("NaN is not allowed"),
    252        NULL_NOT_ALLOWED("null is not allowed"), /* keep */
    253        ARRAY_ZERO_LENGTH_OR_NULL_NOT_ALLOWED("a null or zero length array not allowed"),
    254        COVARIANCE_MATRIX("covariance matrix"), /* keep */
    255        DENOMINATOR("denominator"), /* keep */
    256        DENOMINATOR_FORMAT("denominator format"), /* keep */
    257        FRACTION("fraction"), /* keep */
    258        FUNCTION("function"), /* keep */
    259        IMAGINARY_FORMAT("imaginary format"), /* keep */
    260        INPUT_ARRAY("input array"), /* keep */
    261        NUMERATOR("numerator"), /* keep */
    262        NUMERATOR_FORMAT("numerator format"), /* keep */
    263        OBJECT_TRANSFORMATION("conversion exception in transformation"), /* keep */
    264        REAL_FORMAT("real format"), /* keep */
    265        WHOLE_FORMAT("whole format"), /* keep */
    266        NUMBER_TOO_LARGE("{0} is larger than the maximum ({1})"), /* keep */
    267        NUMBER_TOO_SMALL("{0} is smaller than the minimum ({1})"), /* keep */
    268        NUMBER_TOO_LARGE_BOUND_EXCLUDED("{0} is larger than, or equal to, the maximum ({1})"), /* keep */
    269        NUMBER_TOO_SMALL_BOUND_EXCLUDED("{0} is smaller than, or equal to, the minimum ({1})"), /* keep */
    270        NUMBER_OF_SUCCESS_LARGER_THAN_POPULATION_SIZE("number of successes ({0}) must be less than or equal to population size ({1})"),
    271        NUMERATOR_OVERFLOW_AFTER_MULTIPLY("overflow, numerator too large after multiply: {0}"),
    272        N_POINTS_GAUSS_LEGENDRE_INTEGRATOR_NOT_SUPPORTED("{0} points Legendre-Gauss integrator not supported, number of points must be in the {1}-{2} range"),
    273        OBSERVED_COUNTS_ALL_ZERO("observed counts are all 0 in observed array {0}"),
    274        OBSERVED_COUNTS_BOTTH_ZERO_FOR_ENTRY("observed counts are both zero for entry {0}"),
    275        BOBYQA_BOUND_DIFFERENCE_CONDITION("the difference between the upper and lower bound must be larger than twice the initial trust region radius ({0})"),
    276        OUT_OF_BOUNDS_QUANTILE_VALUE("out of bounds quantile value: {0}, must be in (0, 100]"),
    277        OUT_OF_BOUND_SIGNIFICANCE_LEVEL("out of bounds significance level {0}, must be between {1} and {2}"),
    278        SIGNIFICANCE_LEVEL("significance level ({0})"), /* keep */
    279        OUT_OF_ORDER_ABSCISSA_ARRAY("the abscissae array must be sorted in a strictly increasing order, but the {0}-th element is {1} whereas {2}-th is {3}"),
    280        OUT_OF_RANGE_ROOT_OF_UNITY_INDEX("out of range root of unity index {0} (must be in [{1};{2}])"),
    281        OUT_OF_RANGE("out of range"), /* keep */
    282        OUT_OF_RANGE_SIMPLE("{0} out of [{1}, {2}] range"), /* keep */
    283        OUT_OF_RANGE_LEFT("{0} out of ({1}, {2}] range"),
    284        OUT_OF_RANGE_RIGHT("{0} out of [{1}, {2}) range"),
    285        OUTLINE_BOUNDARY_LOOP_OPEN("an outline boundary loop is open"),
    286        OVERFLOW("overflow"), /* keep */
    287        OVERFLOW_IN_FRACTION("overflow in fraction {0}/{1}, cannot negate"),
    288        OVERFLOW_IN_ADDITION("overflow in addition: {0} + {1}"),
    289        OVERFLOW_IN_SUBTRACTION("overflow in subtraction: {0} - {1}"),
    290        PERCENTILE_IMPLEMENTATION_CANNOT_ACCESS_METHOD("cannot access {0} method in percentile implementation {1}"),
    291        PERCENTILE_IMPLEMENTATION_UNSUPPORTED_METHOD("percentile implementation {0} does not support {1}"),
    292        PERMUTATION_EXCEEDS_N("permutation size ({0}) exceeds permuation domain ({1})"), /* keep */
    293        POLYNOMIAL("polynomial"), /* keep */
    294        POLYNOMIAL_INTERPOLANTS_MISMATCH_SEGMENTS("number of polynomial interpolants must match the number of segments ({0} != {1} - 1)"),
    295        POPULATION_LIMIT_NOT_POSITIVE("population limit has to be positive"),
    296        POWER_NEGATIVE_PARAMETERS("cannot raise an integral value to a negative power ({0}^{1})"),
    297        PROPAGATION_DIRECTION_MISMATCH("propagation direction mismatch"),
    298        RANDOMKEY_MUTATION_WRONG_CLASS("RandomKeyMutation works only with RandomKeys, not {0}"),
    299        ROOTS_OF_UNITY_NOT_COMPUTED_YET("roots of unity have not been computed yet"),
    300        ROTATION_MATRIX_DIMENSIONS("a {0}x{1} matrix cannot be a rotation matrix"),
    301        ROW_INDEX_OUT_OF_RANGE("row index {0} out of allowed range [{1}, {2}]"),
    302        ROW_INDEX("row index ({0})"), /* keep */
    303        SAME_SIGN_AT_ENDPOINTS("function values at endpoints do not have different signs, endpoints: [{0}, {1}], values: [{2}, {3}]"),
    304        SAMPLE_SIZE_EXCEEDS_COLLECTION_SIZE("sample size ({0}) exceeds collection size ({1})"), /* keep */
    305        SAMPLE_SIZE_LARGER_THAN_POPULATION_SIZE("sample size ({0}) must be less than or equal to population size ({1})"),
    306        SIMPLEX_NEED_ONE_POINT("simplex must contain at least one point"),
    307        SIMPLE_MESSAGE("{0}"),
    308        SINGULAR_MATRIX("matrix is singular"), /* keep */
    309        SINGULAR_OPERATOR("operator is singular"),
    310        SUBARRAY_ENDS_AFTER_ARRAY_END("subarray ends after array end"),
    311        TOO_LARGE_CUTOFF_SINGULAR_VALUE("cutoff singular value is {0}, should be at most {1}"),
    312        TOO_LARGE_TOURNAMENT_ARITY("tournament arity ({0}) cannot be bigger than population size ({1})"),
    313        TOO_MANY_ELEMENTS_TO_DISCARD_FROM_ARRAY("cannot discard {0} elements from a {1} elements array"),
    314        TOO_MANY_REGRESSORS("too many regressors ({0}) specified, only {1} in the model"),
    315        TOO_SMALL_COST_RELATIVE_TOLERANCE("cost relative tolerance is too small ({0}), no further reduction in the sum of squares is possible"),
    316        TOO_SMALL_INTEGRATION_INTERVAL("too small integration interval: length = {0}"),
    317        TOO_SMALL_ORTHOGONALITY_TOLERANCE("orthogonality tolerance is too small ({0}), solution is orthogonal to the jacobian"),
    318        TOO_SMALL_PARAMETERS_RELATIVE_TOLERANCE("parameters relative tolerance is too small ({0}), no further improvement in the approximate solution is possible"),
    319        TRUST_REGION_STEP_FAILED("trust region step has failed to reduce Q"),
    320        TWO_OR_MORE_CATEGORIES_REQUIRED("two or more categories required, got {0}"),
    321        TWO_OR_MORE_VALUES_IN_CATEGORY_REQUIRED("two or more values required in each category, one has {0}"),
    322        UNABLE_TO_BRACKET_OPTIMUM_IN_LINE_SEARCH("unable to bracket optimum in line search"),
    323        UNABLE_TO_COMPUTE_COVARIANCE_SINGULAR_PROBLEM("unable to compute covariances: singular problem"),
    324        UNABLE_TO_FIRST_GUESS_HARMONIC_COEFFICIENTS("unable to first guess the harmonic coefficients"),
    325        UNABLE_TO_ORTHOGONOLIZE_MATRIX("unable to orthogonalize matrix in {0} iterations"),
    326        UNABLE_TO_PERFORM_QR_DECOMPOSITION_ON_JACOBIAN("unable to perform Q.R decomposition on the {0}x{1} jacobian matrix"),
    327        UNABLE_TO_SOLVE_SINGULAR_PROBLEM("unable to solve: singular problem"),
    328        UNBOUNDED_SOLUTION("unbounded solution"),
    329        UNKNOWN_MODE("unknown mode {0}, known modes: {1} ({2}), {3} ({4}), {5} ({6}), {7} ({8}), {9} ({10}) and {11} ({12})"),
    330        UNKNOWN_PARAMETER("unknown parameter {0}"),
    331        UNMATCHED_ODE_IN_EXPANDED_SET("ode does not match the main ode set in the extended set"),
    332        CANNOT_PARSE_AS_TYPE("string \"{0}\" unparseable (from position {1}) as an object of type {2}"), /* keep */
    333        CANNOT_PARSE("string \"{0}\" unparseable (from position {1})"), /* keep */
    334        UNPARSEABLE_3D_VECTOR("unparseable 3D vector: \"{0}\""),
    335        UNPARSEABLE_COMPLEX_NUMBER("unparseable complex number: \"{0}\""),
    336        UNPARSEABLE_REAL_VECTOR("unparseable real vector: \"{0}\""),
    337        UNSUPPORTED_EXPANSION_MODE("unsupported expansion mode {0}, supported modes are {1} ({2}) and {3} ({4})"),
    338        UNSUPPORTED_OPERATION("unsupported operation"), /* keep */
    339        ARITHMETIC_EXCEPTION("arithmetic exception"), /* keep */
    340        ILLEGAL_STATE("illegal state"), /* keep */
    341        USER_EXCEPTION("exception generated in user code"), /* keep */
    342        URL_CONTAINS_NO_DATA("URL {0} contains no data"),
    343        VALUES_ADDED_BEFORE_CONFIGURING_STATISTIC("{0} values have been added before statistic is configured"),
    344        VECTOR_LENGTH_MISMATCH("vector length mismatch: got {0} but expected {1}"),
    345        VECTOR_MUST_HAVE_AT_LEAST_ONE_ELEMENT("vector must have at least one element"),
    346        WEIGHT_AT_LEAST_ONE_NON_ZERO("weigth array must contain at least one non-zero value"),
    347        WRONG_BLOCK_LENGTH("wrong array shape (block length = {0}, expected {1})"),
    348        WRONG_NUMBER_OF_POINTS("{0} points are required, got only {1}"),
    349        NUMBER_OF_POINTS("number of points ({0})"), /* keep */
    350        ZERO_DENOMINATOR("denominator must be different from 0"), /* keep */
    351        ZERO_DENOMINATOR_IN_FRACTION("zero denominator in fraction {0}/{1}"),
    352        ZERO_FRACTION_TO_DIVIDE_BY("the fraction to divide by must not be zero: {0}/{1}"),
    353        ZERO_NORM("zero norm"),
    354        ZERO_NORM_FOR_ROTATION_AXIS("zero norm for rotation axis"),
    355        ZERO_NORM_FOR_ROTATION_DEFINING_VECTOR("zero norm for rotation defining vector"),
    356        ZERO_NOT_ALLOWED("zero not allowed here");
    357
    358        // CHECKSTYLE: resume JavadocVariable
    359        // CHECKSTYLE: resume MultipleVariableDeclarations
    360
    361
    362        /** Source English format. */
    363        private final String sourceFormat;
    364
    365        /** Simple constructor.
    366         * @param sourceFormat source English format to use when no
    367         * localized version is available
    368         */
    369        private LocalizedFormats(final String sourceFormat) {
    370            this.sourceFormat = sourceFormat;
    371        }
    372
    373        /** {@inheritDoc} */
    374        public String getSourceString() {
    375            return sourceFormat;
    376        }
    377
    378        /** {@inheritDoc} */
    379        public String getLocalizedString(final Locale locale) {
    380            try {
    381                final String path = LocalizedFormats.class.getName().replaceAll("\\.", "/");
    382                ResourceBundle bundle =
    383                        ResourceBundle.getBundle("assets/" + path, locale);
    384                if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {
    385                    // the value of the resource is the translated format
    386                    return bundle.getString(toString());
    387                }
    388
    389            } catch (MissingResourceException mre) { // NOPMD
    390                // do nothing here
    391            }
    392
    393            // either the locale is not supported or the resource is unknown
    394            // don't translate and fall back to using the source format
    395            return sourceFormat;
    396
    397        }
    398
    399    }