【我的Java笔记】API的建成（工具类）

1.需要定义一个类（工具类），给该类写上文档注释

2.需要将该类无参构造私有化（防止让外界创建对象）

3.成员方法全部用 “static” 关键字修饰

4.建成API的方式：

  在DOS命令栏中需要找到.Java文件所在的目录
dos--->.java文件所在目录---->javadoc -d 新建的文件名 -author -version ArrayTool.java

例：

/**
 * 
 * 该类是针对数组操作的一个工具类,里面有一些对数组操作的功能
 * @author Apple
 * @version V1.0
 * */
public class ArrayTool {
	//无参构造私有,目的为了不让外界其对象
	private ArrayTool(){
		
	}
	
	/**
	 * 该方法是针对数组的遍历的方法,遍历的元素[元素1, 元素2, 元素, ....]
	 * @param 
	 * 			arr :需要被遍历的数组
	 * */
	public static void printArray(int[] arr){
		System.out.print("[");
		for(int x = 0 ; x < arr.length ; x ++){
			if(x==arr.length-1){
				System.out.println(arr[x]+"]");
			}else{
				System.out.print(arr[x]+", ");
			}
		}
	}
	/**
	 * 该方法是针对数组获取最大值的方法
	 * @param 
	 * 			arr :需要被遍历的 数组,可以获取每一个元素
	 * @return
	 * 			返回的就是数组中最大值
	 * 
	 * */
	public static int getMax(int[] arr){
		//定义参照物
		int max = arr[0] ;
		//遍历其他索引
		for(int x = 1 ; x < arr.length ;x ++){
			//判断
			if(arr[x]>max){
				max = arr[x] ;
			}
		}
		
		return max ;
	}
	
	/**
	 * 该方法是查询数组中的元素在数组中第一次出现的索引
	 * @param 
	 * 			arr : 需要查询的数组
	 * @param	
	 * 			value:需要被查找的远古时
	 * @return	
	 * 			如果查到了当前索引对应的元素,那么就直接返回当前索引,如果查不到,则返回-1
	 * */
	public static int getIndex(int[] arr,int value){
		//假设法
		//定义一个索引:假设查不到
		int index = -1 ;
		
		//遍历数组
		for(int x = 0 ; x < arr.length ; x ++){
			//判断:如果刚好查到的x索引对应的元素和value相等,那么返回该索引
			if(arr[x]==value){
				//表查到了
				//给索引遍历重新赋值
				index  = x ;
				break ;
			}
		}
		return index ;
		
		
	}
}

 //测试类
 public class ArrayDemo {
	public static void main(String[] args) {
		//定义一个数组,静态初始化
		int[] arr = {24,69,80,57,13} ;
		
		
		//遍历数组
		ArrayTool.printArray(arr) ;
		
		//获取数组中的最大值
		int result = ArrayTool.getMax(arr) ;
		System.out.println("result:"+result);
		
		//查询577元素
		int index = ArrayTool.getIndex(arr, 577) ;
		System.out.println("index:"+index);
		
		int index2 = ArrayTool.getIndex(arr, 57) ;
		System.out.println("index2:"+index2);
		
	}
}

2017.10.22