1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License, Version 1.0 only
   6  * (the "License").  You may not use this file except in compliance
   7  * with the License.
   8  *
   9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10  * or http://www.opensolaris.org/os/licensing.
  11  * See the License for the specific language governing permissions
  12  * and limitations under the License.
  13  *
  14  * When distributing Covered Code, include this CDDL HEADER in each
  15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16  * If applicable, add the following below this CDDL HEADER, with the
  17  * fields enclosed by brackets "[]" replaced with your own identifying
  18  * information: Portions Copyright [yyyy] [name of copyright owner]
  19  *
  20  * CDDL HEADER END
  21  */
  22 /*
  23  * ident        "%Z%%M% %I%     %E% SMI"
  24  *
  25  * Copyright 2002 Sun Microsystems, Inc.  All rights reserved.
  26  * Use is subject to license terms.
  27  */
  28 
  29 package com.sun.dhcpmgr.data.qualifier;
  30 
  31 /**
  32  * Common interface for qualifier types.
  33  */
  34 public interface QualifierType {
  35 
  36     /**
  37      * Determine if the given string is a legal value for this type.
  38      *
  39      * @param value
  40      *   The value to test.
  41      * @return
  42      *   Returns a Java type containing the parsed value if legal, otherwise
  43      *   null is returned if the value was illegal.
  44      */
  45     public Object parseValue(String value);
  46 
  47     /**
  48      * Format the value into a form that could be offered to parseValue().
  49      * The validity of the value is implementation dependent. The value
  50      * passed to formatValue() may result in a non-null result but the same
  51      * value passed to parseValue() may return null. Also the value returned
  52      * by formatValue() passed to parseValue() does not guarantee an non-null
  53      * result from parseValue().
  54      *
  55      * @param value
  56      *   The value to format.
  57      * @return
  58      *   Returns a String containing the formatted value or null if the
  59      *   value could not be formatted correctly.
  60      */
  61     public String formatValue(String value);
  62 
  63     /**
  64      * Get the Java class that is suitable for storing values of the qualifier
  65      * type.
  66      *
  67      *  @return
  68      *    Suitable Java type for storing values of the qualifier type.
  69      */
  70     public Class getJavaType();
  71 
  72     public String toString();
  73 
  74 }