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 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.api; 028 029 030 031 /** 032 * This interface defines a set of methods that must be implemented by 033 * any class that forms the basis for a protocol element (e.g., an 034 * ASN.1 element, an LDAP message, etc.). 035 */ 036 @org.opends.server.types.PublicAPI( 037 stability=org.opends.server.types.StabilityLevel.VOLATILE, 038 mayInstantiate=false, 039 mayExtend=true, 040 mayInvoke=true) 041 public interface ProtocolElement 042 { 043 /** 044 * Retrieves the name of the protocol associated with this protocol 045 * element. 046 * 047 * @return The name of the protocol associated with this protocol 048 * element. 049 */ 050 public String getProtocolElementName(); 051 052 053 054 /** 055 * Retrieves a string representation of this protocol element. 056 * 057 * @return A string representation of this protocol element. 058 */ 059 public String toString(); 060 061 062 063 /** 064 * Appends a string representation of this protocol element to the 065 * provided buffer. 066 * 067 * @param buffer The buffer into which the string representation 068 * should be written. 069 */ 070 public void toString(StringBuilder buffer); 071 072 073 074 /** 075 * Appends a string representation of this protocol element to the 076 * provided buffer. 077 * 078 * @param buffer The buffer into which the string representation 079 * should be written. 080 * @param indent The number of spaces that should be used to 081 * indent the resulting string representation. 082 */ 083 public void toString(StringBuilder buffer, int indent); 084 } 085