org.odftoolkit.odfdom.pkg.dsig.DocumentSignaturesElement Maven / Gradle / Ivy

/**
 * **********************************************************************
 *
 * 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.dsig;

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

/**
 * Data signature implementation of OpenDocument element {@odf.element dsig:document-signatures}.
 */
public class DocumentSignaturesElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfPackageNamespace.DSIG, "document-signatures");

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

  /**
   * Get the element name
   *
   * @return return OdfName the name of element {@odf.element
   *     dsig:document-signatures}.
   */
  @Override
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation VersionAttribute , See
   * {@odf.attribute dsig:version}
   *
   * 
Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getVersionAttribute() {
    VersionAttribute attr = (VersionAttribute) getOdfAttribute(OdfPackageNamespace.DSIG, "version");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation VersionAttribute , See
   * {@odf.attribute dsig:version}
   *
   * @param versionValue The type is String
   */
  public void setVersionAttribute(String versionValue) {
    VersionAttribute attr = new VersionAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(versionValue);
  }

  /**
   * Create child element {@odf.element ds:Signature}.
   *
   * 
Child element is new in Odf 1.2
   *
   * Child element is mandatory.
   *
   * @return the element {@odf.element ds:Signature}
   */
  public SignatureElement newSignatureElement() {
    SignatureElement dsSignature =
        ((OdfFileDom) this.ownerDocument).newOdfElement(SignatureElement.class);
    this.appendChild(dsSignature);
    return dsSignature;
  }
}