001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.util.cli; 028 029 030 031 /** 032 * An interface for validating user input. 033 * 034 * @param <T> 035 * The type of the decoded input. 036 */ 037 public interface ValidationCallback<T> { 038 039 /** 040 * Validates and decodes the user-provided input. Implementations 041 * must validate <code>input</code> and return the decoded value 042 * if the input is acceptable. If the input is unacceptable, 043 * implementations must return <code>null</code> and output a user 044 * friendly error message to the provided application console. 045 * 046 * @param app 047 * The console application. 048 * @param input 049 * The user input to be validated. 050 * @return Returns the decoded input if the input is valid, or 051 * <code>null</code> if it is not. 052 * @throws CLIException 053 * If an unexpected error occurred which prevented 054 * validation. 055 */ 056 T validate(ConsoleApplication app, String input) throws CLIException; 057 }