usr/src/java/adr/org/opensolaris/os/adr/MethodDiff.java
author devjani.ray@oracle.com <devjani.ray@oracle.com>
Fri, 06 May 2011 14:55:38 -0400
changeset 699 34ec90cc612c
parent 628 9c2bcc10515e
permissions -rw-r--r--
adrgen5 - documentation generator
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
628
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     1
/*
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     2
 * CDDL HEADER START
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     3
 *
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     4
 * The contents of this file are subject to the terms of the
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     5
 * Common Development and Distribution License (the "License").
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     6
 * You may not use this file except in compliance with the License.
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     7
 *
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     8
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
     9
 * or http://www.opensolaris.org/os/licensing.
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    10
 * See the License for the specific language governing permissions
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    11
 * and limitations under the License.
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    12
 *
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    13
 * When distributing Covered Code, include this CDDL HEADER in each
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    14
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    15
 * If applicable, add the following below this CDDL HEADER, with the
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    16
 * fields enclosed by brackets "[]" replaced with your own identifying
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    17
 * information: Portions Copyright [yyyy] [name of copyright owner]
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    18
 *
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    19
 * CDDL HEADER END
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    20
 */
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    21
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    22
/*
699
34ec90cc612c adrgen5 - documentation generator
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents: 628
diff changeset
    23
 * Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved.
628
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    24
 */
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    25
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    26
package org.opensolaris.os.adr;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    27
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    28
import java.util.HashSet;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    29
import java.util.List;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    30
import java.util.Map;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    31
import java.util.Set;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    32
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    33
public class MethodDiff extends FeatureDiff<Method> {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    34
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    35
    public MethodDiff(Map<Stability, Diff> diffs) {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    36
	super(diffs);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    37
    }
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    38
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    39
    void generateDiffs(Map<String, Method> methodsOld,
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    40
	Map<String, Method> methodsNew) {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    41
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    42
	Set<String> common = getDiffSet(methodsOld, methodsNew);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    43
	for (String mname : common) {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    44
	    Method mOld = methodsOld.get(mname);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    45
	    Method mNew = methodsNew.get(mname);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    46
	    assert (mOld != null && mNew != null);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    47
	    updateFeatureDiffs(mOld, mNew, true, false);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    48
	    updateDiffs(mOld.getStability(),
699
34ec90cc612c adrgen5 - documentation generator
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents: 628
diff changeset
    49
		diffTypeError(mOld.getErrorType(), mNew.getErrorType()));
628
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    50
	    updateDiffs(mOld.getStability(), diffArgs(mOld.getArguments(),
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    51
		mNew.getArguments()));
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    52
	}
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    53
    }
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    54
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    55
    /*
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    56
     * A change in the number of args is an incompatible change
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    57
     * A change in the order of the args (types) is an incompatible change
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    58
     * A change of args from optional to required is an incompatible change
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    59
     * A change of args from required to optional is a compatible change
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    60
     */
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    61
    private Diff diffArgs(List<Argument> aold, List<Argument> anew) {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    62
	if (aold == null || anew == null)
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    63
	    return (aold == null && anew == null) ? Diff.NONE :
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    64
		Diff.INCOMPATIBLE;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    65
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    66
	if (aold.size() != anew.size())
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    67
	    return Diff.INCOMPATIBLE;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    68
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    69
	Diff diff = Diff.NONE;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    70
	Argument[] oldarr = new Argument[aold.size()];
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    71
	aold.toArray(oldarr);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    72
	Argument[] newarr = new Argument[aold.size()];
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    73
	anew.toArray(newarr);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    74
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    75
	for (int i = 0; i < aold.size(); i++) {
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    76
	    Diff adiff = diffOptional(oldarr[i].isOptional(),
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    77
		    newarr[i].isOptional(), false, true);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    78
	    if (adiff.compareTo(diff) > 0)
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    79
		diff = adiff;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    80
	    adiff = diffType(oldarr[i].getType(), newarr[i].getType(),
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    81
		false, true);
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    82
	    if (adiff.compareTo(diff) > 0)
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    83
		diff = adiff;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    84
	}
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    85
	return diff;
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    86
    }
9c2bcc10515e Bug 17664 - ADRGEN-1: Interface comparison, versioning validation
devjani.ray@oracle.com <devjani.ray@oracle.com>
parents:
diff changeset
    87
}