All files / src/contracts/documents java.ts

100% Statements 20/20
100% Branches 2/2
100% Functions 1/1
100% Lines 20/20

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153                                        12x 12x   12x 12x                                                                                                                                                                               12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x                                                  
/*
    Copyright (C) 2017 Red Hat, Inc.
 
    Licensed 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.
*/
import { CollectionType, IField, IStringList } from '../common';
 
/**
 * The Java class inspection data model contracts between frontend and backend.
 */
export const JAVA_MODEL_PACKAGE_PREFIX = 'io.atlasmap.java.v2';
export const JAVA_INSPECTION_REQUEST_JSON_TYPE =
  JAVA_MODEL_PACKAGE_PREFIX + '.ClassInspectionRequest';
export const JAVA_CLASS_JSON_TYPE = JAVA_MODEL_PACKAGE_PREFIX + '.JavaClass';
export const JAVA_ENUM_FIELD_JSON_TYPE =
  JAVA_MODEL_PACKAGE_PREFIX + '.JavaEnumField';
 
/**
 * The root object that carries {@link IClassInspectionRequest}
 * when it's sent to backend.
 */
export interface IClassInspectionRequestContainer {
  ClassInspectionRequest: IClassInspectionRequest;
}
 
/**
 * The serialized Java class inspection request.
 */
export interface IClassInspectionRequest {
  jsonType: string;
  fieldNameExclusions?: IStringList;
  classNameExclusions?: IStringList;
  classpath?: string;
  className: string;
  collectionType?: CollectionType;
  collectionClassName?: string;
  disablePrivateOnlyFields?: boolean;
  disableProtectedOnlyFields?: boolean;
  disablePublicOnlyFields?: boolean;
  disablePublicGetterSetterFields?: boolean;
}
 
/**
 * The root object that carries {@link IClassInspectionResponse}
 * when it's received from backend.
 */
export interface IClassInspectionResponseContainer {
  ClassInspectionResponse: IClassInspectionResponse;
}
 
/**
 * The serialized Java class inspection response.
 */
export interface IClassInspectionResponse {
  javaClass: IJavaClass;
  errorMessage: string;
  executionTime: number;
}
 
/**
 * The root object that carries {@link IJavaClass}
 * when it's read from Java offline inspection (maven plugin).
 */
export interface IJavaClassContainer {
  JavaClass: IJavaClass;
}
 
/**
 * The serialized Java class inspection result.
 */
export interface IJavaClass extends IJavaField {
  javaEnumFields: IJavaEnumFields;
  javaFields: IJavaFields;
  packageName: string;
  annotation: boolean;
  annonymous: boolean;
  enumeration: boolean;
  isInterface: boolean;
  localClass: boolean;
  memberClass: boolean;
  uri: string;
}
 
/**
 * The serialized Java field.
 */
export interface IJavaField extends IField {
  annotations?: IStringList;
  modifiers?: { modifier: Modifier[] };
  parameterizedTypes?: IStringList;
  className?: string;
  canonicalClassName?: string;
  collectionClassName?: string;
  getMethod?: string;
  setMethod?: string;
  primitive?: boolean;
  synthetic?: boolean;
}
 
/**
 * The serialized Java modifier.
 */
export enum Modifier {
  ALL = 'ALL',
  ABSTRACT = 'ABSTRACT',
  FINAL = 'FINAL',
  INTERFACE = 'INTERFACE',
  NATIVE = 'NATIVE',
  PACKAGE_PRIVATE = 'Package Private',
  PUBLIC = 'PUBLIC',
  PROTECTED = 'PROTECTED',
  PRIVATE = 'PRIVATE',
  STATIC = 'STATIC',
  STRICT = 'STRICT',
  SYNCHRONIZED = 'SYNCHRONIZED',
  TRANSIENT = 'TRANSIENT',
  VOLATILE = 'VOLATILE',
  NONE = 'NONE',
}
 
/**
 * The container of serialized {@link IJavaEnumField}.
 */
export interface IJavaEnumFields {
  javaEnumField: IJavaEnumField[];
}
 
/**
 * The serialized Java enum field.
 */
export interface IJavaEnumField extends IField {
  name: string;
  ordinal: number;
  className: string;
}
 
/**
 * The container of serialized {@link IJavaField}.
 */
export interface IJavaFields {
  javaField: IJavaField[];
}