/*
* Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* $Id: XPathFilter2ParameterSpec.java,v 1.7 2005/05/13 18:45:42 mullan Exp $
*/
package javax.xml.crypto.dsig.spec;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.xml.crypto.dsig.Transform;
Parameters for the W3C Recommendation
XPath Filter 2.0 Transform Algorithm. The parameters include a list of one or more XPathType
objects. Author: Sean Mullan, JSR 105 Expert Group See Also: Since: 1.6
/**
* Parameters for the W3C Recommendation
* <a href="http://www.w3.org/TR/xmldsig-filter2/">
* XPath Filter 2.0 Transform Algorithm</a>.
* The parameters include a list of one or more {@link XPathType} objects.
*
* @author Sean Mullan
* @author JSR 105 Expert Group
* @since 1.6
* @see Transform
* @see XPathFilterParameterSpec
*/
public final class XPathFilter2ParameterSpec implements TransformParameterSpec {
private final List<XPathType> xPathList;
Creates an XPathFilter2ParameterSpec
.
Params: - xPathList – a list of one or more
XPathType
objects. The list is defensively copied to protect against subsequent modification.
Throws: - ClassCastException – if
xPathList
contains any entries that are not of type XPathType
- IllegalArgumentException – if
xPathList
is empty - NullPointerException – if
xPathList
is
null
/**
* Creates an <code>XPathFilter2ParameterSpec</code>.
*
* @param xPathList a list of one or more {@link XPathType} objects. The
* list is defensively copied to protect against subsequent modification.
* @throws ClassCastException if <code>xPathList</code> contains any
* entries that are not of type {@link XPathType}
* @throws IllegalArgumentException if <code>xPathList</code> is empty
* @throws NullPointerException if <code>xPathList</code> is
* <code>null</code>
*/
@SuppressWarnings("rawtypes")
public XPathFilter2ParameterSpec(List xPathList) {
if (xPathList == null) {
throw new NullPointerException("xPathList cannot be null");
}
List<?> xPathListCopy = new ArrayList<>((List<?>)xPathList);
if (xPathListCopy.isEmpty()) {
throw new IllegalArgumentException("xPathList cannot be empty");
}
int size = xPathListCopy.size();
for (int i = 0; i < size; i++) {
if (!(xPathListCopy.get(i) instanceof XPathType)) {
throw new ClassCastException
("xPathList["+i+"] is not a valid type");
}
}
@SuppressWarnings("unchecked")
List<XPathType> temp = (List<XPathType>)xPathListCopy;
this.xPathList = Collections.unmodifiableList(temp);
}
Returns a list of one or more XPathType
objects. This implementation returns an
unmodifiable list
.
Returns: a List
of XPathType
objects
(never null
or empty)
/**
* Returns a list of one or more {@link XPathType} objects.
* <p>
* This implementation returns an {@link Collections#unmodifiableList
* unmodifiable list}.
*
* @return a <code>List</code> of <code>XPathType</code> objects
* (never <code>null</code> or empty)
*/
@SuppressWarnings("rawtypes")
public List getXPathList() {
return xPathList;
}
}