Class ClassUseMapper


  • @Deprecated
    public class ClassUseMapper
    extends java.lang.Object
    Deprecated.
    Map all class uses for a given class.

    This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

    Since:
    1.2
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      private <T extends ProgramElementDoc>
      void
      add​(java.util.Map<java.lang.String,​java.util.List<T>> map, ClassDoc cd, T ref)
      Deprecated.
       
      private void addAll​(java.util.Map<java.lang.String,​java.util.List<ClassDoc>> map, ClassDoc cd, java.util.Collection<ClassDoc> refs)
      Deprecated.
       
      private <T extends ProgramElementDoc>
      void
      addTypeParameterToMap​(java.util.Map<java.lang.String,​java.util.List<T>> map, Type type, T holder)
      Deprecated.
       
      private java.util.Set<ClassDoc> classSet​(ClassDoc cd)
      Deprecated.
       
      private java.util.Collection<ClassDoc> implementingClasses​(ClassDoc cd)
      Deprecated.
      Return all implementing classes of an interface (including all subclasses of implementing classes and all classes implementing subinterfaces) AND fill-in both classToImplementingClass and classToSubinterface maps.
      private <T extends PackageDoc>
      void
      mapAnnotations​(java.util.Map<java.lang.String,​java.util.List<T>> map, PackageDoc doc, T holder)
      Deprecated.
      Map the AnnotationType to the ProgramElementDocs that use them as type parameters.
      private <T extends ProgramElementDoc>
      void
      mapAnnotations​(java.util.Map<java.lang.String,​java.util.List<T>> map, java.lang.Object doc, T holder)
      Deprecated.
      Map the AnnotationType to the ProgramElementDocs that use them as type parameters.
      private void mapExecutable​(ExecutableMemberDoc em)
      Deprecated.
      Determine classes used by a method or constructor, so they can be inverse mapped.
      private <T extends ProgramElementDoc>
      void
      mapTypeParameters​(java.util.Map<java.lang.String,​java.util.List<T>> map, java.lang.Object doc, T holder)
      Deprecated.
      Map the ClassDocs to the ProgramElementDocs that use them as type parameters.
      private java.util.Set<PackageDoc> packageSet​(ClassDoc cd)
      Deprecated.
       
      private <T> java.util.List<T> refList​(java.util.Map<java.lang.String,​java.util.List<T>> map, ClassDoc cd)
      Deprecated.
       
      private java.util.Collection<ClassDoc> subclasses​(ClassDoc cd)
      Deprecated.
      Return all subclasses of a class AND fill-in classToSubclass map.
      private java.util.Collection<ClassDoc> subinterfaces​(ClassDoc cd)
      Deprecated.
      Return all subinterfaces of an interface AND fill-in classToSubinterface map.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • classtree

        private final ClassTree classtree
        Deprecated.
      • classToPackage

        public java.util.Map<java.lang.String,​java.util.Set<PackageDoc>> classToPackage
        Deprecated.
        Mapping of ClassDocs to set of PackageDoc used by that class. Entries may be null.
      • classToPackageAnnotations

        public java.util.Map<java.lang.String,​java.util.List<PackageDoc>> classToPackageAnnotations
        Deprecated.
        Mapping of Annotations to set of PackageDoc that use the annotation.
      • classToClass

        public java.util.Map<java.lang.String,​java.util.Set<ClassDoc>> classToClass
        Deprecated.
        Mapping of ClassDocs to set of ClassDoc used by that class. Entries may be null.
      • classToSubclass

        public java.util.Map<java.lang.String,​java.util.List<ClassDoc>> classToSubclass
        Deprecated.
        Mapping of ClassDocs to list of ClassDoc which are direct or indirect subclasses of that class. Entries may be null.
      • classToSubinterface

        public java.util.Map<java.lang.String,​java.util.List<ClassDoc>> classToSubinterface
        Deprecated.
        Mapping of ClassDocs to list of ClassDoc which are direct or indirect subinterfaces of that interface. Entries may be null.
      • classToImplementingClass

        public java.util.Map<java.lang.String,​java.util.List<ClassDoc>> classToImplementingClass
        Deprecated.
        Mapping of ClassDocs to list of ClassDoc which implement this interface. Entries may be null.
      • classToField

        public java.util.Map<java.lang.String,​java.util.List<FieldDoc>> classToField
        Deprecated.
        Mapping of ClassDocs to list of FieldDoc declared as that class. Entries may be null.
      • classToMethodReturn

        public java.util.Map<java.lang.String,​java.util.List<MethodDoc>> classToMethodReturn
        Deprecated.
        Mapping of ClassDocs to list of MethodDoc returning that class. Entries may be null.
      • classToMethodArgs

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToMethodArgs
        Deprecated.
        Mapping of ClassDocs to list of MethodDoc having that class as an arg. Entries may be null.
      • classToMethodThrows

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToMethodThrows
        Deprecated.
        Mapping of ClassDocs to list of MethodDoc which throws that class. Entries may be null.
      • classToConstructorArgs

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToConstructorArgs
        Deprecated.
        Mapping of ClassDocs to list of ConstructorDoc having that class as an arg. Entries may be null.
      • classToConstructorThrows

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToConstructorThrows
        Deprecated.
        Mapping of ClassDocs to list of ConstructorDoc which throws that class. Entries may be null.
      • classToConstructorAnnotations

        public java.util.Map<java.lang.String,​java.util.List<ConstructorDoc>> classToConstructorAnnotations
        Deprecated.
        The mapping of AnnotationTypeDocs to constructors that use them.
      • classToConstructorParamAnnotation

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToConstructorParamAnnotation
        Deprecated.
        The mapping of AnnotationTypeDocs to Constructor parameters that use them.
      • classToConstructorDocArgTypeParam

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToConstructorDocArgTypeParam
        Deprecated.
        The mapping of ClassDocs to Constructor arguments that use them as type parameters.
      • classToClassTypeParam

        public java.util.Map<java.lang.String,​java.util.List<ClassDoc>> classToClassTypeParam
        Deprecated.
        The mapping of ClassDocs to ClassDocs that use them as type parameters.
      • classToClassAnnotations

        public java.util.Map<java.lang.String,​java.util.List<ClassDoc>> classToClassAnnotations
        Deprecated.
        The mapping of AnnotationTypeDocs to ClassDocs that use them.
      • classToExecMemberDocTypeParam

        public java.util.Map<java.lang.String,​java.util.List<MethodDoc>> classToExecMemberDocTypeParam
        Deprecated.
        The mapping of ClassDocs to ExecutableMemberDocs that use them as type parameters.
      • classToExecMemberDocArgTypeParam

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToExecMemberDocArgTypeParam
        Deprecated.
        The mapping of ClassDocs to ExecutableMemberDocs arguments that use them as type parameters.
      • classToExecMemberDocAnnotations

        public java.util.Map<java.lang.String,​java.util.List<MethodDoc>> classToExecMemberDocAnnotations
        Deprecated.
        The mapping of AnnotationTypeDocs to ExecutableMemberDocs that use them.
      • classToExecMemberDocReturnTypeParam

        public java.util.Map<java.lang.String,​java.util.List<MethodDoc>> classToExecMemberDocReturnTypeParam
        Deprecated.
        The mapping of ClassDocs to ExecutableMemberDocs that have return type with type parameters of that class.
      • classToExecMemberDocParamAnnotation

        public java.util.Map<java.lang.String,​java.util.List<ExecutableMemberDoc>> classToExecMemberDocParamAnnotation
        Deprecated.
        The mapping of AnnotationTypeDocs to MethodDoc parameters that use them.
      • classToFieldDocTypeParam

        public java.util.Map<java.lang.String,​java.util.List<FieldDoc>> classToFieldDocTypeParam
        Deprecated.
        The mapping of ClassDocs to FieldDocs that use them as type parameters.
      • annotationToFieldDoc

        public java.util.Map<java.lang.String,​java.util.List<FieldDoc>> annotationToFieldDoc
        Deprecated.
        The mapping of AnnotationTypeDocs to FieldDocs that use them.
      • utils

        private final Utils utils
        Deprecated.
    • Method Detail

      • subclasses

        private java.util.Collection<ClassDoc> subclasses​(ClassDoc cd)
        Deprecated.
        Return all subclasses of a class AND fill-in classToSubclass map.
      • subinterfaces

        private java.util.Collection<ClassDoc> subinterfaces​(ClassDoc cd)
        Deprecated.
        Return all subinterfaces of an interface AND fill-in classToSubinterface map.
      • implementingClasses

        private java.util.Collection<ClassDoc> implementingClasses​(ClassDoc cd)
        Deprecated.
        Return all implementing classes of an interface (including all subclasses of implementing classes and all classes implementing subinterfaces) AND fill-in both classToImplementingClass and classToSubinterface maps.
      • mapExecutable

        private void mapExecutable​(ExecutableMemberDoc em)
        Deprecated.
        Determine classes used by a method or constructor, so they can be inverse mapped.
      • refList

        private <T> java.util.List<T> refList​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                              ClassDoc cd)
        Deprecated.
      • classSet

        private java.util.Set<ClassDoc> classSet​(ClassDoc cd)
        Deprecated.
      • add

        private <T extends ProgramElementDoc> void add​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                                       ClassDoc cd,
                                                       T ref)
        Deprecated.
      • addAll

        private void addAll​(java.util.Map<java.lang.String,​java.util.List<ClassDoc>> map,
                            ClassDoc cd,
                            java.util.Collection<ClassDoc> refs)
        Deprecated.
      • mapTypeParameters

        private <T extends ProgramElementDoc> void mapTypeParameters​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                                                     java.lang.Object doc,
                                                                     T holder)
        Deprecated.
        Map the ClassDocs to the ProgramElementDocs that use them as type parameters.
        Parameters:
        map - the map the insert the information into.
        doc - the doc whose type parameters are being checked.
        holder - the holder that owns the type parameters.
      • mapAnnotations

        private <T extends ProgramElementDoc> void mapAnnotations​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                                                  java.lang.Object doc,
                                                                  T holder)
        Deprecated.
        Map the AnnotationType to the ProgramElementDocs that use them as type parameters.
        Parameters:
        map - the map the insert the information into.
        doc - the doc whose type parameters are being checked.
        holder - the holder that owns the type parameters.
      • mapAnnotations

        private <T extends PackageDoc> void mapAnnotations​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                                           PackageDoc doc,
                                                           T holder)
        Deprecated.
        Map the AnnotationType to the ProgramElementDocs that use them as type parameters.
        Parameters:
        map - the map the insert the information into.
        doc - the doc whose type parameters are being checked.
        holder - the holder that owns the type parameters.
      • addTypeParameterToMap

        private <T extends ProgramElementDoc> void addTypeParameterToMap​(java.util.Map<java.lang.String,​java.util.List<T>> map,
                                                                         Type type,
                                                                         T holder)
        Deprecated.