blob: 53ec84387b1990cfc7a098fd205bc601f45c3be6 [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25package java.security.spec;
26
27/**
28 * This immutable class specifies the set of parameters used for
29 * generating elliptic curve (EC) domain parameters.
30 *
31 * @see AlgorithmParameterSpec
32 *
33 * @author Valerie Peng
34 *
35 * @since 1.5
36 */
37public class ECGenParameterSpec implements AlgorithmParameterSpec {
38
39 private String name;
40
41 /**
42 * Creates a parameter specification for EC parameter
43 * generation using a standard (or predefined) name
44 * <code>stdName</code> in order to generate the corresponding
45 * (precomputed) elliptic curve domain parameters. For the
46 * list of supported names, please consult the documentation
47 * of provider whose implementation will be used.
48 * @param stdName the standard name of the to-be-generated EC
49 * domain parameters.
50 * @exception NullPointerException if <code>stdName</code>
51 * is null.
52 */
53 public ECGenParameterSpec(String stdName) {
54 if (stdName == null) {
55 throw new NullPointerException("stdName is null");
56 }
57 this.name = stdName;
58 }
59
60 /**
61 * Returns the standard or predefined name of the
62 * to-be-generated EC domain parameters.
63 * @return the standard or predefined name.
64 */
65 public String getName() {
66 return name;
67 }
68}