Mercurial > jdk8-mips64-public > jaxws / annotate
src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/TubeCloner.java@9c07ef4934dd (annotated)
src/share/jaxws_classes/com/sun/xml/internal/ws/api/pipe/TubeCloner.java
Thu, 31 Aug 2017 15:18:52 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:18:52 +0800
- changeset 637
- 9c07ef4934dd
- parent 368
- 0989ad8c0860
- parent 0
- 373ffda63c9a
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.xml.internal.ws.api.pipe; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.util.Map; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | /** |
| aoqi@0 | 31 | * Clones the whole pipeline. |
| aoqi@0 | 32 | * |
| aoqi@0 | 33 | * <p> |
| aoqi@0 | 34 | * Since {@link Tube}s may form an arbitrary directed graph, someone needs |
| aoqi@0 | 35 | * to keep track of isomorphism for a clone to happen correctly. This class |
| aoqi@0 | 36 | * serves that role. |
| aoqi@0 | 37 | * |
| aoqi@0 | 38 | * @author Kohsuke Kawaguchi |
| aoqi@0 | 39 | */ |
| aoqi@0 | 40 | public abstract class TubeCloner { |
| aoqi@0 | 41 | // Pipe to pipe, or tube to tube |
| aoqi@0 | 42 | public final Map<Object,Object> master2copy; |
| aoqi@0 | 43 | |
| aoqi@0 | 44 | /** |
| aoqi@0 | 45 | * Invoked by a client of a tube to clone the whole pipeline. |
| aoqi@0 | 46 | * |
| aoqi@0 | 47 | * <p> |
| aoqi@0 | 48 | * {@link Tube}s implementing the {@link Tube#copy(com.sun.xml.internal.ws.api.pipe.TubeCloner)} method |
| aoqi@0 | 49 | * shall use {@link #copy(Tube)} method. |
| aoqi@0 | 50 | * |
| aoqi@0 | 51 | * @param p |
| aoqi@0 | 52 | * The entry point of a pipeline to be copied. must not be null. |
| aoqi@0 | 53 | * @return |
| aoqi@0 | 54 | * The cloned pipeline. Always non-null. |
| aoqi@0 | 55 | */ |
| aoqi@0 | 56 | @SuppressWarnings("deprecation") |
| aoqi@0 | 57 | public static Tube clone(Tube p) { |
| aoqi@0 | 58 | // we often want to downcast TubeCloner to PipeCloner, |
| aoqi@0 | 59 | // so let's create PipeCloner to make that possible |
| aoqi@0 | 60 | return new PipeClonerImpl().copy(p); |
| aoqi@0 | 61 | } |
| aoqi@0 | 62 | |
| aoqi@0 | 63 | // no need to be constructed publicly. always use the static clone method. |
| aoqi@0 | 64 | /*package*/ TubeCloner(Map<Object,Object> master2copy) { |
| aoqi@0 | 65 | this.master2copy = master2copy; |
| aoqi@0 | 66 | } |
| aoqi@0 | 67 | |
| aoqi@0 | 68 | /** |
| aoqi@0 | 69 | * Invoked by a {@link Tube#copy(com.sun.xml.internal.ws.api.pipe.TubeCloner)} implementation |
| aoqi@0 | 70 | * to copy a reference to another pipe. |
| aoqi@0 | 71 | * |
| aoqi@0 | 72 | * <p> |
| aoqi@0 | 73 | * This method is for {@link Tube} implementations, not for users. |
| aoqi@0 | 74 | * |
| aoqi@0 | 75 | * <p> |
| aoqi@0 | 76 | * If the given tube is already copied for this cloning episode, |
| aoqi@0 | 77 | * this method simply returns that reference. Otherwise it copies |
| aoqi@0 | 78 | * a tube, make a note, and returns a copied tube. This additional |
| aoqi@0 | 79 | * step ensures that a graph is cloned isomorphically correctly. |
| aoqi@0 | 80 | * |
| aoqi@0 | 81 | * <p> |
| aoqi@0 | 82 | * (Think about what happens when a graph is A->B, A->C, B->D, and C->D |
| aoqi@0 | 83 | * if you don't have this step.) |
| aoqi@0 | 84 | * |
| aoqi@0 | 85 | * @param t |
| aoqi@0 | 86 | * The tube to be copied. |
| aoqi@0 | 87 | * @return |
| aoqi@0 | 88 | * The cloned tube. Always non-null. |
| aoqi@0 | 89 | */ |
| aoqi@0 | 90 | public abstract <T extends Tube> T copy(T t); |
| aoqi@0 | 91 | |
| aoqi@0 | 92 | /** |
| aoqi@0 | 93 | * This method must be called from within the copy constructor |
| aoqi@0 | 94 | * to notify that the copy was created. |
| aoqi@0 | 95 | * |
| aoqi@0 | 96 | * <p> |
| aoqi@0 | 97 | * When your pipe has references to other pipes, |
| aoqi@0 | 98 | * it's particularly important to call this method |
| aoqi@0 | 99 | * before you start copying the pipes you refer to, |
| aoqi@0 | 100 | * or else there's a chance of inifinite loop. |
| aoqi@0 | 101 | */ |
| aoqi@0 | 102 | public abstract void add(Tube original, Tube copy); |
| aoqi@0 | 103 | } |
