1/*
2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26/*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file, and Oracle licenses the original version of this file under the BSD
31 * license:
32 */
33/*
34   Copyright 2015 Attila Szegedi
35
36   Licensed under both the Apache License, Version 2.0 (the "Apache License")
37   and the BSD License (the "BSD License"), with licensee being free to
38   choose either of the two at their discretion.
39
40   You may not use this file except in compliance with either the Apache
41   License or the BSD License.
42
43   If you choose to use this file in compliance with the Apache License, the
44   following notice applies to you:
45
46       You may obtain a copy of the Apache License at
47
48           http://www.apache.org/licenses/LICENSE-2.0
49
50       Unless required by applicable law or agreed to in writing, software
51       distributed under the License is distributed on an "AS IS" BASIS,
52       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
53       implied. See the License for the specific language governing
54       permissions and limitations under the License.
55
56   If you choose to use this file in compliance with the BSD License, the
57   following notice applies to you:
58
59       Redistribution and use in source and binary forms, with or without
60       modification, are permitted provided that the following conditions are
61       met:
62       * Redistributions of source code must retain the above copyright
63         notice, this list of conditions and the following disclaimer.
64       * Redistributions in binary form must reproduce the above copyright
65         notice, this list of conditions and the following disclaimer in the
66         documentation and/or other materials provided with the distribution.
67       * Neither the name of the copyright holder nor the names of
68         contributors may be used to endorse or promote products derived from
69         this software without specific prior written permission.
70
71       THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
72       IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
73       TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
74       PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER
75       BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
76       CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
77       SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
78       BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
79       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
80       OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
81       ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
82*/
83
84package jdk.dynalink;
85
86/**
87 * An object that describes a dynamic operation. Dynalink defines a set of
88 * standard operations with the {@link StandardOperation} class, as well as a
89 * way to express the target {@link Namespace namespace(s)} of an operation
90 * on an object using {@link NamespaceOperation} and finally a way to attach
91 * a fixed target name to an operation using {@link NamedOperation}.
92 * When presenting examples in this documentation, we will refer to standard
93 * operations using their name (e.g. {@code GET}), to namespace operations
94 * by separating their base operation with a colon from their namespace
95 * (e.g. {@code GET:PROPERTY}), or in case of multiple namespaces we will
96 * further separate those with the vertical line character (e.g.
97 * {@code GET:PROPERTY|ELEMENT}), and finally we will refer to named operations
98 * by separating the base operation and the name with the colon character (e.g.
99 * {@code GET:PROPERTY|ELEMENT:color}).
100 */
101public interface Operation {
102    /**
103     * Returns a {@link NamespaceOperation} using this operation as its base.
104     * @param namespace the namespace that is the target of the namespace operation.
105     * @return a {@link NamespaceOperation} with this operation as its base and the specified
106     * namespace as its target.
107     * @throws IllegalArgumentException if this operation is already a namespace operation or a named operation.
108     * @throws NullPointerException if {@code namespace} is null.
109     */
110    default NamespaceOperation withNamespace(final Namespace namespace) {
111        return withNamespaces(namespace);
112    }
113
114    /**
115     * Returns a {@link NamespaceOperation} using this operation as its base.
116     * @param namespaces the namespaces that are the target of the namespace operation.
117     * @return a {@link NamespaceOperation} with this operation as its base and the specified
118     * namespaces as its targets.
119     * @throws IllegalArgumentException if this operation is already a namespace operation or a named operation.
120     * @throws NullPointerException if {@code namespace} or any of its elements is null.
121     */
122    default NamespaceOperation withNamespaces(final Namespace... namespaces) {
123        return new NamespaceOperation(this, namespaces);
124    }
125
126    /**
127     * Returns a {@link NamedOperation} using this operation as its base.
128     * @param name the name that is the target of the named operation.
129     * @return a {@link NamedOperation} with this operation as its base and the specified name.
130     * @throws IllegalArgumentException if this operation is already a named operation.
131     * @throws NullPointerException if {@code name} is null.
132     */
133    default NamedOperation named(final Object name) {
134        return new NamedOperation(this, name);
135    }
136}
137