Module imagingbook.core
Package imagingbook.core.jdoc

Interface JavaDocHelp

All Known Implementing Classes:
Adaptive_All, Adaptive_Bernsen, Adaptive_Niblack, Adaptive_Sauvola, Alpha_Blending_Stack, Axis_Aligned_Bounding_Box, Bilateral_Filter, Bin_Morphology_Disk, Bin_Morphology_Free, Brighten_Index_Image, Brighten_Rgb_1, Brighten_Rgb_2, Canny_Edges, Cartoon_Effect, Chamfer_Matching, Circle_Fitting, Circle_Make_Random, Close_Other_Images, Color_Edges_Canny, Color_Edges_DiZenzo, Color_Edges_Gray, Color_Edges_Monochromatic, Compute_Histogram, Convert_From_AdobeRGB, Convert_ImagePlus_To_Gray, Convert_Images_To_PNG, Convert_Rgb_To_Gray, Convert_To_Color_Stack, Convex_Hull_Demo, CorrelCoefficient_Matching, Count_Colors, Create_New_Byte_Image, Custom_Generic_Filter_Scalar, Custom_Generic_Filter_Vector, Data_Transfer_Plugin_Consumer, Data_Transfer_Plugin_Producer, DCT_2D_Demo, Delaunay_Demo, Desaturate_RGB, DFT_2D_Demo, Dilate_Disk_Demo, Direct_Byte_Pixel_Access, Draw_Test_Grid, Ellipse_Closest_Points_Demo, Ellipse_Fitting, Ellipse_Make_Random, Equalize_Histogram, Export_PDF, Filter_Arbitrary, Filter_Box_3x3, Filter_Demo_A, Filter_Demo_B, Filter_Median, Filter_Smooth_3x3, Find_Corners, Flusser_Moments_Covariance_Matrix, Flusser_Moments_From_Binary_Regions, Flusser_Moments_Matching_Demo, Fourier_Descriptor_Animation, Fourier_Descriptor_Trigonometic, Gamma_Correction, Gaussian_Filter, Gaussian_Filter_HSV, Gaussian_Filter_RGB, Gaussian_Filter_Separable, Generic_Dialog_Example, Geometry_Rotate_Color, Global_All, Global_Isodata, Global_MaxEntropy, Global_Mean, Global_Median, Global_MinError, Global_MinMax, Global_Otsu, Global_Quantile, Hough_Line_Detect, Hsv_Rotate_Hue, ImageAccessor_Demo_Scalar, ImageAccessor_Demo_Vector, Index_To_Rgb, Integral_Image_Demo, Integral_Image_GetRoiStatistics, Jitter_Filter_GenericFilter, Jitter_Filter_ImageAccessor, Jitter_Filter_Simple, Kuwahara_Filter, Line_Fitting, Line_Make_Random, Line_Rotation_Demo, Linear_Blending_Stack, Linear_Filter_3x3, Linear_Filter_3x3_Separable, LucasKanade_Demo, Major_Axis_Demo, Make_Projections, Make_Uniform_Noise, Map_Affine_Matrix, Map_Affine_Triangles, Map_Bilinear, Map_LogPolar_Demo, Map_Nonlinear_Ripple, Map_Nonlinear_Tapestry, Map_Nonlinear_Twirl, Map_Projective, Map_Rotate_Center, Map_Rotate_Origin, Map_Translate, Match_Gaussian_Histogram, Match_Piecewise_Linear_Histogram, Match_Reference_Histogram_Stack, MedianFilter_Scalar, MedianFilter_Vector, MedianFilter_VectorSharpen, Mesh_Warp_Interactive, MSER_Detection_Demo, My_Inverter_A, My_Inverter_B, Nagao_Matsuyama_Filter, Open_Sample_Image, Open_Sample_Image_For_PlugInFilter, Outline_Demo, OutOfBoundsStrategy_Demo, Perlin_Noise_2D, Perona_Malik_Filter, Perona_Malik_Minimal, Pixel_Interpolation_Demo, Plot_Chromaticity_Chart, Quantize_Color_Image, Raise_Contrast, Raise_Contrast_Fast, Random_Hues_Demo, Ransac_Circle_Detect, Ransac_Ellipse_Detect, Ransac_Line_Detect, Rectify_Quad_Selection, Region_Contours_Demo, Region_Eccentricity_Ellipse_Demo, Region_Segmentation_Demo, Roi_Extract_Subimage_Demo, Roi_Processing_Demo1, Roi_Processing_Demo2, Run_Command_From_PlugIn, Run_Command_From_PlugInFilter, Show_Component_Tree_Stack, Show_Distance_Map, Show_Histogram, Show_Scale_Space, SIFT_Detection_Demo, SIFT_Matching_Demo, Sobel_Edges_Colored, Stack_Processing_Demo, Thinning_Demo, Tschumperle_Deriche_Filter, Unlock_Image, Unsharp_Masking_Filter, UpdateAndDraw_Demo, Zoom_Exact, Zoom_To_Selection
public interface JavaDocHelp
Classes implementing this interface provide a URL that links to the associated JavaDoc page (returned by method getJavaDocUrl()). This is mainly intended as help information in user dialogs of ImageJ plugins.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getJavaDocUrl()
    Returns a JavaDoc URL for this object's class.
    static String
    getJavaDocUrl(Class<?> clazz)
    Returns the JavaDoc URL for the specified class, which is obtained from the value of JavaDocBaseUrl annotations present at the PACKAGE level (in file package-info.java).
    static boolean
    isValidURL(String url)
    Checks if the specified string is a valid URL.

  • Method Details

    • getJavaDocUrl

      default String getJavaDocUrl()
      Returns a JavaDoc URL for this object's class.
      Returns:
      a JavaDoc URL

    • getJavaDocUrl

      static String getJavaDocUrl(Class<?> clazz)
      Returns the JavaDoc URL for the specified class, which is obtained from the value of JavaDocBaseUrl annotations present at the PACKAGE level (in file package-info.java). Note that there is no guarantee that the associated JavaDoc exists at the resulting address (this is not checked by unit tests).
      Parameters:
      clazz - a class reference
      Returns:
      a string with the web URL for the JavaDoc information of the specified class

    • isValidURL

      static boolean isValidURL(String url)
      Checks if the specified string is a valid URL. Does the standard (non-perfect) URL/URI check followed by some additional checks that could indicate likely definition errors.
      Parameters:
      url - the string to be checked
      Returns:
      true iff a valid URL