/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2008 Sun Microsystems, Inc.
 */
package org.opends.server.extensions;



import org.opends.messages.MessageBuilder;
import org.opends.server.types.AccountStatusNotification;



/**
 * This class defines the base class for elements that may be used to generate
 * an account status notification message.
 */
public abstract class NotificationMessageTemplateElement
{
  /**
   * Indicates, whether to append text to the {@link MessageBuilder} is 
   * ({@code null}), in lowerCase ({@link Boolean#TRUE}) or uppercase otherwise. 
   */
  protected Boolean toLower;

  /**
   * Checks, whether the given <var>options</var> String contains either an 'u' 
   * or 'l' as its last character. If this is the case, {@link #toLower} gets 
   * set accordingly ('l' indicates lowerCase, 'u' upperCase) and the 
   * <var>options</var> gets returned with the corresponding character removed.
   * 
   * @param options     the option string to parse. Ignored if {@code null} or
   *    empty.
   * @return the given <var>options</var> String with 'l' or 'u' removed from
   *    its end.
   */
  protected String checkCase(String options) {
    if (options == null || options.isEmpty()) {
      return options;
    }
    char c = options.charAt(options.length() - 1);
    if (c == 'l' || c == 'u') {
      toLower = c == 'l' ? Boolean.TRUE : Boolean.FALSE;
      options = options.substring(0, options.length() - 1);
    }
    return options;
  }

  /**
   * Generates a value for this template element using the information contained
   * in the provided account status notification and appends it to the given
   * buffer.
   *
   * @param  buffer        The buffer to which the generated value should be
   *                       appended.
   * @param  notification  The account status notification to process.
   */
  public abstract void generateValue(MessageBuilder buffer,
                                     AccountStatusNotification notification);
}