StringUtil.java 19 KB
Newer Older
Lee Jaebin committed
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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
package jp.agentec.adf.util;

import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.net.URLEncoder;
import java.text.NumberFormat;
import java.util.LinkedList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import jp.agentec.abook.abv.bl.common.exception.ABVRuntimeException;

/**
 * 文字列を扱うための便利機能を提供します。
 * @author macrojin
 * @version 1.0.1
 */
public class StringUtil {
	/**
	 * 空の文字列を表します。 このフィールドは読み取り専用です。<br>
	 * このフィールドの値は、長さ 0 の文字列 "" です。
	 * @since 1.0.0
	 */
	public static final String Empty = "";
	/**
	 * 空白(スペース)文字列を示します。このフィールドは読み取り専用です。
	 * @since 1.0.0
	 */
	public static final String Space = " ";
	/**
	 * キャリッジリターン(CR)文字の\rです。このフィールドは読み取り専用です。
	 * @since 1.0.0
	 */
	public static final String CarriageReturn = "\r";
	/**
	 * ラインフィード(LF)文字の\nです。このフィールドは読み取り専用です。
	 * @since 1.0.0  
	 */
	public static final String LineFeed = "\n";
	/**
	 * CRLFをあわせたものです。
	 * @since 1.0.1
	 */
	public static final String CRLF = CarriageReturn + LineFeed;
	
	/**
	 * スラッシュ文字です。
	 * @since 1.0.0
	 */
	public static final String Slash = "/";
	public static final String BackSlash = "\\";
	public static final String Hyphen = "-";
	
	private static final String RegexBriceL = "[";
	private static final String RegexBriceR = "]";
	private static final String RegexPlus = "+";
	private static final String RegexAlphabet = "a-zA-Z";
	private static final String RegexNumeric = "0-9";
	private static final String RegexTrimLastSlashOrSpace = "[/ ]+$";
	
	private static String ELLIPSIS = "...";

	/**
	 * 指定された文字列が null または  {@link StringUtil#Empty} 文字列であるかどうかを示します。
	 * @param s テストする文字列。
	 * @return s パラメーターが null または空の文字列 ("") の場合は true。それ以外の場合は false。
	 * @since 1.0.0
	 */
	public static boolean isNullOrEmpty(String s) {
		return s == null || s.equals(Empty);
	}
	
	/**
	 * 指定された文字列が null または  {@link StringUtil#Empty} 文字列であるかどうかを示します。
	 * @param s テストする文字列。
	 * @return パラメーターが null または空の文字列 ("") の場合は true。それ以外の場合は false。
	 * @since 1.0.0
	 */
	public static boolean isNullOrEmpty(StringBuffer s) {
		return s == null || isNullOrEmpty(s.toString());
	}
	
	/**
	 * 指定された文字列が null または  {@link StringUtil#Empty} 文字列であるかどうかを示します。
	 * @param s テストする文字列。
	 * @return パラメーターが null または空の文字列 ("") の場合は true。それ以外の場合は false。
	 * @since 1.0.0
	 */
	public static boolean isNullOrEmpty(StringBuilder s) {
		return s == null || isNullOrEmpty(s.toString());
	}
	
	/**
	 * 指定された文字列が null または空であるか、空白文字だけで構成されているかどうかを示します。
	 * @param s テストする文字列。
	 * @return s パラメーターが null または {@link StringUtil#Empty} であるか、s が空白文字だけで構成されている場合は true。
	 * @since 1.0.0
	 */
	public static boolean isNullOrWhiteSpace(String s) {
		return isNullOrEmpty(s) || s.trim().length() == 0;
	}
	
	/**
	 * 指定された文字列が null または空であるか、空白文字だけで構成されているかどうかを示します。
	 * @param s テストする文字列。
	 * @return s パラメーターが null または {@link StringUtil#Empty} であるか、s が空白文字だけで構成されている場合は true。
	 * @since 1.0.0
	 */
	public static boolean isNullOrWhiteSpace(StringBuffer s) {
		return isNullOrEmpty(s) || s.toString().trim().length() == 0;
	}
	
	/**
	 * 指定された文字列が null または空であるか、空白文字だけで構成されているかどうかを示します。
	 * @param s テストする文字列。
	 * @return s パラメーターが null または {@link StringUtil#Empty} であるか、s が空白文字だけで構成されている場合は true。
	 * @since 1.0.0
	 */
	public static boolean isNullOrWhiteSpace(StringBuilder s) {
		return isNullOrEmpty(s) || s.toString().trim().length() == 0;
	}
	
	/**
	 * オブジェクトを文字列に変換します。変換には {@link Object#toString()} を利用します。
	 * @param obj 変換するオブジェクトです。
	 * @return 変換した文字列を返します。変換できない場合、又は変換した文字列が空文字である場合、{@link StringUtil#Empty} を返します。。
	 * @since 
	 */
	public static String toString(Object obj) {
		return toString(obj, Empty);
	}
	
	/**
	 * オブジェクトを文字列に変換します。変換には {@link Object#toString()} を利用します。
	 * @param obj 変換するオブジェクトです。
	 * @param defaultValue 変換できない場合、又は変換した文字列が空文字である場合、使用するデフォルト値です。
	 * @return 変換した文字列を返します。変換できない場合、又は変換した文字列が空文字である場合、defaultValueを返します。
	 * @since 
	 */
	public static String toString(Object obj, String defaultValue) {
		if (obj != null && !isNullOrEmpty(obj.toString())) { // Comment: toStringを2度呼んでいるためパフォーマンスが低下
			return obj.toString();
		} else {
			return defaultValue;
		}
	}
	
	/**
	 * 指定された文字列を空にします。
	 * @param s 空にする文字列
	 * @since 1.0.0
	 */
	public static void clear(StringBuffer s) {
		if (!isNullOrEmpty(s) && s.length() > 0) {
			s.delete(0, s.length());
		}
	}
	
	/**
	 * 指定された文字列を空にします。
	 * @param s 空にする文字列
	 * @since 1.0.0
	 */
	public static void clear(StringBuilder s) {
		if (!isNullOrEmpty(s) && s.length() > 0) {
			s.delete(0, s.length());
		}
	}
	
	/**
	 * 文字列の最後を改行します。
	 * @param s 改行する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuffer s) {
		s.append(StringUtil.LineFeed);
	}
	
	/**
	 * 文字列の最後を改行します。
	 * @param s 改行する文字列
	 * @since 1.0.0 
	 */
	public static void appendLine(StringBuilder s) {
		s.append(StringUtil.LineFeed);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuffer s, String arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuilder s, String arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param args 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendMultiLine(StringBuffer s, String...args) {
		for (String string : args) {
			appendLine(s, string);
		}
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param args 追加する文字列
	 * 
	 * @since 1.0.0
	 */
	public static void appendMultiLine(StringBuilder s, String...args) {
		for (String string : args) {
			appendLine(s, string);
		}
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuffer s, int arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuilder s, int arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuffer s, long arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuilder s, long arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuffer s, Object arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 文字列 s に複数の文字列を追加し、改行します。
	 * @param s 改行する文字列
	 * @param arg 追加する文字列
	 * @since 1.0.0
	 */
	public static void appendLine(StringBuilder s, Object arg) {
		s.append(arg);
		appendLine(s);
	}
	
	/**
	 * 指定した文字列を指定した区切りで分割します。分割時にtrimを行います。<br>
	 * 空白の要素は戻り値から省かれます。
	 * @param source 分割する文字列です。
	 * @param delimiter 分割の区切りです。
	 * @return 分割された文字列の配列を返します。
	 * @since 1.0.0
	 */
	public static String[] split(String source, String delimiter) {
		return split(source, delimiter, true);
	}
	
	/**
	 * 指定した文字列を指定した区切りで分割します。
	 * @param source 分割する文字列です。
	 * @param delimiter 分割の区切りです。
	 * @param ignoreEmpty trueにすると、空白の要素は戻り値から省かれます。
	 * @return 分割された文字列の配列を返します。
	 * @since 1.0.0
	 */
	public static String[] split(String source, String delimiter, boolean ignoreEmpty) {
		String[] result = new String[]{source};
		
		if (!isNullOrWhiteSpace(source)) {
			String pattern;
			
			if (ignoreEmpty) {
				pattern = delimiter + "\\s+|" + delimiter;
			} else {
				pattern = delimiter + "\\s|" + delimiter;
			}
			
			result = source.split(pattern);
		}
		
		return result;
	}
	
	/**
	 * 指定した文字列が正しいURLであるかどうかを示します。
	 * @param url テストするURL文字列です。
	 * @return 文字列が正常なURLを示すとtrueを返します。
	 * @since 1.0.0
	 */
	public static boolean validateUrlString(String url) {
		boolean result = true;
		
		try {
            //noinspection ResultOfObjectAllocationIgnored
            new URL(url);
		} catch (Exception e) {
			result = false;
		}
		
		return result;
	}
	
	/**
	 * 指定したURL文字列の後端に/が付いていなければ、/を付けます。<br>
	 * この際、文字列が正しいURLであるかどうかを確認し、有効なURLではない場合、nullを返します。
	 * @param url URL文字列です。
	 * @return 後端に/を付けたURL文字列です。
	 * @since 1.0.0
	 */
	public static String addSlashToUrlString(String url) {
		String result = null;
		
		if (validateUrlString(url)) {
			String temp = url.trim();
			
			if (!temp.endsWith("/")) {
				temp += "/";
			}
			
			result = temp;
		}
		
		return result;
	}
	
	/**
	 * 指定した文字列が半角文字だけで構成されているかどうかを示します。
	 * @param s テストする文字列です。
	 * @param allowAlphabet trueにすると半角英字を許容します。
	 * @param allowNumeric trueにすると半角数字を許容します。
	 * @param allowSymbols 英数字以外に許容したい記号を指定します。たとえば、文字列にスペースを許容したい場合、ここにスペースを指定します。この記号が半角かどうかは判別しません。
	 * @return sが指定した条件に合致するとtrueを返します。
	 * @since 1.0.0
	 */
	public static boolean isHankaku(String s, boolean allowAlphabet, boolean allowNumeric, String...allowSymbols) {
		boolean result = false;
		StringBuffer pattern = new StringBuffer();
		
		if (!isNullOrEmpty(s)
				&& (allowAlphabet
						|| allowNumeric
						|| (allowSymbols != null && allowSymbols.length > 0)
					)
				) {
			pattern.append(RegexBriceL);
			
			if (allowAlphabet) {
				pattern.append(RegexAlphabet);
			}
			
			if (allowNumeric) {
				pattern.append(RegexNumeric);
			}
			
			if (allowSymbols != null && allowSymbols.length > 0) {
				for (String symbol : allowSymbols) {
					if (symbol.equals(Hyphen) || symbol.equals(BackSlash)) {
						pattern.append(BackSlash);
						pattern.append(symbol);
					} else {
						pattern.append(symbol);
					}
				}
			}
			
			pattern.append(RegexBriceR);
			pattern.append(RegexPlus);
			
			result = s.matches(pattern.toString());
		}
		
		return result;
	}
	
	/**
	 * 指定した文字列の最後についている/又は空白を除去します。/又は空白が複数あっても最後であれば全て除去します。
	 * @param s 最後の/又は空白を除去する文字列です。
	 * @return 最後の/又は空白を除去した文字列を返します。
	 * @since 1.0.0
	 */
	public static String trimLastSlashOrSpace(String s) {
		String result = null;
		
		if (!StringUtil.isNullOrEmpty(s)) {
			result = s.replaceAll(RegexTrimLastSlashOrSpace, Empty);
		}
		
		return result;
	}
	
	/**
	 * 指定した複数の文字列sをdelimiterを区切りとして結合します。
	 * @param delimiter 文字列と文字列の区切りです。(カンマ、コロン、空白等)
	 * @param s 結合する文字列の配列です。
	 * @return 結合した文字列を返します。
	 * @since 1.0.0
	 */
	public static String join(String delimiter, String...s) {
		StringBuffer sb = new StringBuffer();
		
		if (s != null && s.length > 0) {
			if (delimiter == null) {
				delimiter = Empty;
			}
			
			for (int i = 0; i < s.length; i++) {
				sb.append(s[i]);
				
				if (i < s.length - 1) {
					sb.append(delimiter);
				}
			}
		}
		
		return sb.toString();
	}

	public static String join(String delimiter, List<?> list) {
		StringBuffer sb = new StringBuffer();
		
		if (list != null && !list.isEmpty()) {
			if (delimiter == null) {
				delimiter = Empty;
			}
			
			for (int i = 0; i < list.size(); i++) {
				sb.append(list.get(i));
				
				if (i < list.size() - 1) {
					sb.append(delimiter);
				}
			}
		}
		
		return sb.toString();
	}

	/**
	 * 数字を3桁ごとのカンマ区切りの文字列に変換して返却します。
	 * 
	 * @param num
	 * @return
	 */
	public static String numberDispFormatComma(Integer num) {
		if (num == null) {
			return "";
		}
		NumberFormat numberFormat = NumberFormat.getNumberInstance();
		return  numberFormat.format(num);
	}

	/**
	 * 指定配列に指定文字列が含まれるかどうかを返す
	 * 
	 * @param search
	 * @param array
	 * @return
	 */
	public static boolean contains(String search, String[] array) {
		if (search == null || array == null || array.length == 0) {
			return false;
		}
		
		for (String string : array) {
			if (string != null && string.equals(search)) {
				return true;
			}
		}
		
		return false;
	}
	
	public static String urlEncode(String s, String enc) {
		if (s == null) {
			return null;
		}
		try {
			return URLEncoder.encode(s, enc).replace("+", "%20");
		} catch (UnsupportedEncodingException e) {
			throw new ABVRuntimeException(e);
		}
	}

	public static boolean isNumber(String s) {
		try {
			Long.parseLong(s);
			return true;
		} catch (Exception e) {
			return false;
		}
	}

	public static boolean isReal(String s) {
		try {
			Double.parseDouble(s);
			return true;
		} catch (Exception e) {
			return false;
		}
	}

	public static String chomp(String str) {
		if (str != null && (str.endsWith("\n") || str.endsWith("\r"))) {
			str = str.substring(0, str.length() - 1);
		}
		return str;
	}
	
	/**
	 * 正規表現にしたがって文字列を抽出する
	 *
	 * @param src 対象文字列
	 * @param regex 正規表現
	 * @param index 正規表現中の抽出対象となる()の番号
	 * @return ヒットした最初の文字列
	 */
	public static String extractRegexString(String src, String regex, int index) {
		Pattern regx = Pattern.compile(regex);
		Matcher m = regx.matcher(src);
		if (m.find()) {
			return m.group(index);
		}
		return null;
	}

	/**
	 * 正規表現にしたがって文字列(複数)を抽出する
	 *
	 * @param src 対象文字列
	 * @param regex 正規表現
	 * @param index 正規表現中の抽出対象となる()の番号(配列)
	 * @return ヒットしたすべての文字列リスト
	 */
	public static List<List<String>> extractRegexString(String src, String regex, int[] index) {
		Pattern regx = Pattern.compile(regex);
		List<List<String>> list = new LinkedList<List<String>>();
		Matcher m = regx.matcher(src);
		while (m.find()) {
			List<String> matchList = new LinkedList<String>();
			for (int element : index) {
				matchList.add(m.group(element));
			}
			list.add(matchList);
		}
		return list;
	}


	public static boolean equals(String s1, String s2) {
		if (s1 == null) {
			return s2 == null;
		}
		else {
			return s1.equals(s2);
		}
	}

	/**
	 * 第一引数に、第二引数以降のいずれかが一致した場合trueを返す
	 *
	 * @param s
	 * @param targets
	 * @return
	 */
	public static boolean equalsAny(String s, String... targets) {
		for (String target : targets) {
			if (equals(s, target)) {
				return true;
			}
		}
		return false;
	}

	/**
	 * 指定文字列に、第二引数以降の文字列のいずれかで終わっているか
	 * 
	 * @param target
	 * @param anys
	 * @return
	 */
	public static boolean endsWithAny(String target, String ...anys) {
		if (target == null || anys == null || anys.length == 0) {
			return false;
		}
		for (String any : anys) {
			if (target.endsWith(any)) {
				return true;
			}
		}
		return false;
	}
	

	/**
	 * 文字列長が指定したmaxlengthを越えないように適宜省略する
	 * @param str 表示される文字列
	 * @param maxlength 許容される最大長
	 * @return
	 */
	public static String abbreviate(String str, int maxlength) {
		/* パラメータ補正 */
		if (str == null) {
            str = "";
        }
		if (maxlength < ELLIPSIS.length()) {
			/* ワーストケースでは ... となるため最低3文字必要 */
			throw new IllegalArgumentException("maxlength is too small");
		}

		final int len = str.length();
		if (len <= maxlength) {
			return	str;
		} else if (len > ELLIPSIS.length()) {
			return	str.substring(0, maxlength - ELLIPSIS.length()) + ELLIPSIS;
		} else {
			return	ELLIPSIS;
		}
	}

	public static boolean startsWith(String str, String target) {
		if (isNullOrEmpty(str) || isNullOrEmpty(target)) {
			return false;
		}
		return str.startsWith(target);
	}

}