org.odftoolkit.odfdom.pkg.manifest.AlgorithmElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odfdom-java Show documentation

ODFDOM is an OpenDocument Format (ODF) framework. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language. The current reference implementation is written in Java.

There is a newer version: 1.0.0-BETA1

Show newest version

/**
 * **********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * 
Use is subject to license terms.
 *
 * 
Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You under the Apache 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://www.apache.org/licenses/LICENSE-2.0
 *
 * 
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.
 *
 * 
**********************************************************************
 */

/*
 * This file is automatically generated.
 * Don't edit manually.
 */
package org.odftoolkit.odfdom.pkg.manifest;

import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
import org.odftoolkit.odfdom.pkg.OdfPackageNamespace;

/**
 * Manifest implementation of OpenDocument element {@odf.element manifest:algorithm}.
 *
 * 
This class can have any org.w3c.dom.Element child element.
 */
public class AlgorithmElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfPackageNamespace.MANIFEST, "algorithm");

  /**
   * Create the instance of AlgorithmElement
   *
   * @param ownerDoc The type is OdfFileDom
   */
  public AlgorithmElement(OdfFileDom ownerDoc) {
    super(ownerDoc, ELEMENT_NAME);
  }

  /**
   * Get the element name
   *
   * @return return OdfName the name of element {@odf.element manifest:algorithm}.
   */
  @Override
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation AlgorithmNameAttribute ,
   * See {@odf.attribute manifest:algorithm-name}
   *
   * 
Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getAlgorithmNameAttribute() {
    AlgorithmNameAttribute attr =
        (AlgorithmNameAttribute) getOdfAttribute(AlgorithmNameAttribute.ATTRIBUTE_NAME);
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation AlgorithmNameAttribute , See
   * {@odf.attribute manifest:algorithm-name}
   *
   * @param algorithmNameValue The type is String
   */
  public void setAlgorithmNameAttribute(String algorithmNameValue) {
    AlgorithmNameAttribute attr = new AlgorithmNameAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(algorithmNameValue);
  }

  /**
   * Receives the value of the ODFDOM attribute representation InitialisationVectorAttribute
   *  , See {@odf.attribute manifest:initialisation-vector}
   *
   * Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getInitialisationVectorAttribute() {
    InitialisationVectorAttribute attr =
        (InitialisationVectorAttribute)
            getOdfAttribute(InitialisationVectorAttribute.ATTRIBUTE_NAME);
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation InitialisationVectorAttribute ,
   * See {@odf.attribute manifest:initialisation-vector}
   *
   * @param initialisationVectorValue The type is String
   */
  public void setInitialisationVectorAttribute(String initialisationVectorValue) {
    InitialisationVectorAttribute attr =
        new InitialisationVectorAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(initialisationVectorValue);
  }
}