Format.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */

package org.opencastproject.runtimeinfo.rest;

import org.opencastproject.util.doc.DocData;

/**
 * Represents one possible output format for a REST endpoint
 */
@Deprecated
public final class Format {
  public static final String JSON = "json";
  public static final String XML = "xml";
  public static final String JSON_URL = "http://www.json.org/";
  public static final String XML_URL = "http://www.w3.org/XML/";

  /**
   * @return the standard format object for use with JSON
   */
  public static Format json() {
    return new Format(JSON, null, JSON_URL);
  }

  /**
   * @return the standard format object for use with XML
   */
  public static Format xml() {
    return new Format(XML, null, XML_URL);
  }

  /**
   * @param desc
   *          [optional] description to display with the format
   * @return the standard format object for use with JSON with a description
   */
  public static Format json(String desc) {
    return new Format(JSON, desc, JSON_URL);
  }

  /**
   * @param desc
   *          [optional] description to display with the format
   * @return the standard format object for use with XML with a description
   */
  public static Format xml(String desc) {
    return new Format(XML, desc, XML_URL);
  }

  private String name; // unique key
  private String description;
  private String url;

  /**
   * @param name
   *          the format name (e.g. json)
   * @param description
   *          [optional] a description related to this format
   * @param url
   *          [optional] the url to info about this format OR sample data
   */
  public Format(String name, String description, String url) {
    if (!DocData.isValidName(name)) {
      throw new IllegalArgumentException("name must not be null and must be alphanumeric");
    }
    this.name = name;
    this.description = description;
    this.url = url;
  }

  @Override
  public String toString() {
    return name + ":(" + url + ")";
  }

  public String getName() {
    return name;
  }

  public String getDescription() {
    return description;
  }

  public String getUrl() {
    return url;
  }

}